Undertow 2.3.12.Final · io.undertow.client.ClientConnection

Modifier and Type	Class and Description
public static interface	ClientConnection.PingListener

Method Summary

Modifier and Type	Method and Description
public void	addCloseListener(ChannelListener<ClientConnection> The close listener listener) Adds a close listener, than will be invoked with the connection is closed
public ByteBufferPool	Returns: The buffer pool used by the client getBufferPool()
public ChannelListener.Setter<? extends ClientConnection>	getCloseSetter()
public XnioIoThread	getIoThread()
public SocketAddress	getLocalAddress()
public <A extends SocketAddress> A	getLocalAddress(Class<A> type)
public <T> T	getOption(Option<T> option)
public SocketAddress	getPeerAddress()
public <A extends SocketAddress> A	getPeerAddress(Class<A> type)
public ClientStatistics	Returns: the statistics information, or `null` if statistics are not supported or disabled getStatistics()
public XnioWorker	getWorker()
public boolean	Returns: `true` if this client supports multiplexing isMultiplexingSupported()
public boolean	isOpen() Redeclares java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public default boolean	Returns: `true` if the underlying protocol supports sending a ping isPingSupported()
public boolean	Returns: `true` if this connection support server push isPushSupported()
public boolean	isUpgraded()
public boolean	isUpgradeSupported()
public StreamConnection	Returns: The resulting StreamConnection performUpgrade() Upgrade the connection, if the underlying protocol supports it.
public default void	sendPing(ClientConnection.PingListener listener, long timeout, TimeUnit timeUnit)
public void	sendRequest(final ClientRequest The request to send. request, final ClientCallback<ClientExchange> clientCallback) Sends a client request.
public <T> T	setOption(Option<T> option, T value)
public boolean	supportsOption(Option<?> option)

Inherited from java.nio.channels.Channel:: close

Method Detail

addCloseListener	back to summary
public void addCloseListener(ChannelListener<ClientConnection> listener) Adds a close listener, than will be invoked with the connection is closed Parameters listener:ChannelListener<ClientConnection> The close listener

addCloseListener

back to summary

public void addCloseListener(ChannelListener<ClientConnection> listener)

Adds a close listener, than will be invoked with the connection is closed

Parameters

listener:ChannelListener<ClientConnection>: The close listener

getBufferPool	back to summary
public ByteBufferPool getBufferPool() Returns:ByteBufferPool The buffer pool used by the client

getCloseSetter	back to summary
public ChannelListener.Setter<? extends ClientConnection> getCloseSetter()

getIoThread	back to summary
public XnioIoThread getIoThread()

getLocalAddress	back to summary
public SocketAddress getLocalAddress()

getLocalAddress	back to summary
public <A extends SocketAddress> A getLocalAddress(Class<A> type)

getOption	back to summary
public <T> T getOption(Option<T> option) throws IOException

getPeerAddress	back to summary
public SocketAddress getPeerAddress()

getPeerAddress	back to summary
public <A extends SocketAddress> A getPeerAddress(Class<A> type)

getStatistics	back to summary
public ClientStatistics getStatistics() Returns:ClientStatistics the statistics information, or `null` if statistics are not supported or disabled

getWorker	back to summary
public XnioWorker getWorker()

isMultiplexingSupported	back to summary
public boolean isMultiplexingSupported() Returns:boolean `true` if this client supports multiplexing

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Redeclares java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open

public boolean isOpen()

Redeclares java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean: true if, and only if, this channel is open

isPingSupported	back to summary
public default boolean isPingSupported() Returns:boolean `true` if the underlying protocol supports sending a ping

isPushSupported	back to summary
public boolean isPushSupported() Returns:boolean `true` if this connection support server push

isUpgraded	back to summary
public boolean isUpgraded()

isUpgradeSupported	back to summary
public boolean isUpgradeSupported()

performUpgrade	back to summary
public StreamConnection performUpgrade() throws IOException Upgrade the connection, if the underlying protocol supports it. This should only be called after an upgrade request has been submitted and the target server has accepted the upgrade. Returns:StreamConnection The resulting StreamConnection

performUpgrade

back to summary

public StreamConnection performUpgrade() throws IOException

Upgrade the connection, if the underlying protocol supports it. This should only be called after an upgrade request has been submitted and the target server has accepted the upgrade.

Returns:StreamConnection: The resulting StreamConnection

sendPing	back to summary
public default void sendPing(ClientConnection.PingListener listener, long timeout, TimeUnit timeUnit)

sendRequest back to summary

sendRequest	back to summary
public void sendRequest(final ClientRequest request, final ClientCallback<ClientExchange> clientCallback) Sends a client request. The request object should not be modified after it has been submitted to the connection. Request objects can be queued. Once the request is in a state that it is ready to be sent the `clientCallback` is invoked to provide the caller with the `ClientExchange` If `isMultiplexingSupported()` returns true then multiple requests may be active at the same time, and a later request may complete before an earlier one. Note that the request header may not be written out until after the callback has been invoked. This allows the client to write out a header with a gathering write if the request contains content. Parameters request:ClientRequest The request to send.

public void sendRequest(final ClientRequest request, final ClientCallback<ClientExchange> clientCallback)

Sends a client request. The request object should not be modified after it has been submitted to the connection.

Request objects can be queued. Once the request is in a state that it is ready to be sent the clientCallback is invoked to provide the caller with the ClientExchange

If isMultiplexingSupported() returns true then multiple requests may be active at the same time, and a later request may complete before an earlier one.

Note that the request header may not be written out until after the callback has been invoked. This allows the client to write out a header with a gathering write if the request contains content.

Parameters

request:ClientRequest: The request to send.

setOption	back to summary
public <T> T setOption(Option<T> option, T value) throws IllegalArgumentException, IOException

supportsOption	back to summary
public boolean supportsOption(Option<?> option)

public Interface ClientConnection

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface ClientConnection.PingListener

Method Summary

Method Detail