io.undertow.client

Interface ClientConnection

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Implementing Classes:

HttpClientConnection

public interface ClientConnection
extends Channel

A client connection. This can be used to send requests, or to upgrade the connection.

In general these objects are not thread safe, they should only be used by the IO thread that is responsible for the connection. As a result this client does not provide a mechanism to perform blocking IO, it is designed for async operation only.

Author:

Stuart Douglas

Method Summary

Methods

Modifier and Type	Method and Description
org.xnio.Pool<ByteBuffer>	getBufferPool()
org.xnio.ChannelListener.Setter<? extends ClientConnection>	getCloseSetter()
org.xnio.XnioIoThread	getIoThread()
SocketAddress	getLocalAddress()
<A extends SocketAddress> A	getLocalAddress(Class<A> type)
<T> T	getOption(org.xnio.Option<T> option)
SocketAddress	getPeerAddress()
<A extends SocketAddress> A	getPeerAddress(Class<A> type)
org.xnio.XnioWorker	getWorker()
boolean	isOpen()
boolean	isUpgraded()
org.xnio.StreamConnection	performUpgrade() Upgrade the connection, if the underlying protocol supports it.
void	sendRequest(ClientRequest request, ClientCallback<ClientExchange> clientCallback) Sends a client request.
<T> T	setOption(org.xnio.Option<T> option, T value)
boolean	supportsOption(org.xnio.Option<?> option)

Methods inherited from interface java.nio.channels.Channel

close

Method Detail

sendRequest

void sendRequest(ClientRequest request,
               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

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 - The request to send.

performUpgrade

org.xnio.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:

The resulting StreamConnection

Throws:

IOException

getBufferPool

org.xnio.Pool<ByteBuffer> getBufferPool()

getPeerAddress

SocketAddress getPeerAddress()

getPeerAddress

<A extends SocketAddress> A getPeerAddress(Class<A> type)

getCloseSetter

org.xnio.ChannelListener.Setter<? extends ClientConnection> getCloseSetter()

getLocalAddress

SocketAddress getLocalAddress()

getLocalAddress

<A extends SocketAddress> A getLocalAddress(Class<A> type)

getWorker

org.xnio.XnioWorker getWorker()

getIoThread

org.xnio.XnioIoThread getIoThread()

isOpen

boolean isOpen()

Specified by:

isOpen in interface Channel

supportsOption

boolean supportsOption(org.xnio.Option<?> option)

getOption

<T> T getOption(org.xnio.Option<T> option)
            throws IOException

Throws:

IOException

setOption

<T> T setOption(org.xnio.Option<T> option,
              T value)
            throws IllegalArgumentException,
                   IOException

Throws:

IllegalArgumentException

IOException

isUpgraded

boolean isUpgraded()