# Uses of Interface
org.xnio.IoFuture

Packages that use IoFuture
Package
Description
org.xnio
The main API package for XNIO.
org.xnio.http
org.xnio.ssl
Utility classes for using and implementing SSL within XNIO providers.

## Uses of IoFuture in org.xnio

Classes in org.xnio that implement IoFuture
Modifier and Type
Class
Description
`class`
`AbstractConvertingIoFuture<T,D>`
An `IoFuture` implementation that wraps a different type of `IoFuture`.
`class`
`AbstractIoFuture<T>`
An abstract base class for `IoFuture` objects.
`class`
`FailedIoFuture<T>`
An implementation of `IoFuture` that represents an immediately-failed operation.
`class`
`FinishedIoFuture<T>`
An implementation of `IoFuture` that represents an immediately-successful operation.
Fields in org.xnio declared as IoFuture
Modifier and Type
Field
Description
`protected final IoFuture<? extends D>`
AbstractConvertingIoFuture.`delegate`
The delegate future result.
Methods in org.xnio that return IoFuture
Modifier and Type
Method
Description
`IoFuture<? extends T>`
ChannelDestination.`accept(ChannelListener<? super T> openListener, ChannelListener<? super BoundChannel> bindListener)`
Accept a connection.
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`acceptDatagram(SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`protected IoFuture<MessageConnection>`
XnioIoThread.`acceptLocalMessageConnection(LocalSocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a local (UNIX domain) datagram connection.
`protected IoFuture<StreamConnection>`
XnioIoThread.`acceptLocalStreamConnection(LocalSocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a local (UNIX domain) stream connection.
`IoFuture<MessageConnection>`
XnioIoFactory.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Accept a message connection at a destination address.
`IoFuture<MessageConnection>`
XnioIoThread.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<MessageConnection>`
XnioWorker.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`acceptStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<StreamConnection>`
XnioIoFactory.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Accept a stream connection at a destination address.
`IoFuture<StreamConnection>`
XnioIoThread.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`protected IoFuture<StreamConnection>`
XnioIoThread.`acceptTcpStreamConnection(InetSocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a TCP connection.
`<A> IoFuture<T>`
AbstractConvertingIoFuture.`addNotifier(IoFuture.Notifier<? super T,A> notifier, A attachment)`
`<A> IoFuture<T>`
AbstractIoFuture.`addNotifier(IoFuture.Notifier<? super T,A> notifier, A attachment)`
Add a notifier to be called when this operation is complete.
`<A> IoFuture<T>`
FinishedIoFuture.`addNotifier(IoFuture.Notifier<? super T,A> notifier, A attachment)`
`<A> IoFuture<T>`
IoFuture.`addNotifier(IoFuture.Notifier<? super T,A> notifier, A attachment)`
Add a notifier to be called when this operation is complete.
`IoFuture<T>`
AbstractConvertingIoFuture.`cancel()`
`IoFuture<T>`
AbstractIoFuture.`cancel()`
Cancel an operation.
`IoFuture<T>`
FailedIoFuture.`cancel()`
Cancel the operation.
`IoFuture<T>`
FinishedIoFuture.`cancel()`
Cancel the operation.
`IoFuture<T>`
IoFuture.`cancel()`
Cancel an operation.
`static <I, O> IoFuture<? extends O>`
IoUtils.`cast(IoFuture<I> parent, Class<O> type)`
Create an `IoFuture` which wraps another `IoFuture`, but returns a different type.
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`connectDatagram(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`connectDatagram(SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`protected IoFuture<? extends D>`
AbstractConvertingIoFuture.`getDelegate()`
`IoFuture<T>`
FutureResult.`getIoFuture()`
Get the `IoFuture` for this manager.
`IoFuture<T>`
ChannelSource.`open(ChannelListener<? super T> openListener)`
Open a channel.
`protected IoFuture<MessageConnection>`
XnioIoThread.`openLocalMessageConnection(LocalSocketAddress bindAddress, LocalSocketAddress destinationAddress, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
Implementation helper method to connect to a local (UNIX domain) server.
`protected IoFuture<StreamConnection>`
XnioIoThread.`openLocalStreamConnection(LocalSocketAddress bindAddress, LocalSocketAddress destinationAddress, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to connect to a local (UNIX domain) server.
`IoFuture<MessageConnection>`
XnioIoFactory.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
Connect to a remote message server.
`IoFuture<MessageConnection>`
XnioIoThread.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
`IoFuture<MessageConnection>`
XnioWorker.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
`protected IoFuture<StreamConnection>`
XnioIoThread.`openTcpStreamConnection(InetSocketAddress bindAddress, InetSocketAddress destinationAddress, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to connect to a TCP server.
Methods in org.xnio with parameters of type IoFuture
Modifier and Type
Method
Description
`static void`
IoUtils.`awaitAll(IoFuture<?>... futures)`
Wait for all the futures to complete.
`static void`
IoUtils.`awaitAllInterruptibly(IoFuture<?>... futures)`
Wait for all the futures to complete.
`static <I, O> IoFuture<? extends O>`
IoUtils.`cast(IoFuture<I> parent, Class<O> type)`
Create an `IoFuture` which wraps another `IoFuture`, but returns a different type.
`static <T> Future<T>`
IoUtils.`getFuture(IoFuture<T> ioFuture)`
Get a `java.util.concurrent`-style `Future` instance wrapper for an `IoFuture` instance.
`void`
IoFuture.HandlingNotifier.`notify(IoFuture<? extends T> future, A attachment)`
Receive notification of the completion of an outstanding operation.
`void`
IoFuture.Notifier.`notify(IoFuture<? extends T> ioFuture, A attachment)`
Receive notification of the completion of an outstanding operation.
`static void`
IoUtils.`safeClose(IoFuture<? extends Closeable> futureResource)`
Close a future resource, logging an error if an error occurs.
Constructors in org.xnio with parameters of type IoFuture
Modifier
Constructor
Description
`protected`
`AbstractConvertingIoFuture(IoFuture<? extends D> delegate)`

## Uses of IoFuture in org.xnio.http

Methods in org.xnio.http that return IoFuture
Modifier and Type
Method
Description
`static IoFuture<StreamConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, InetSocketAddress bindAddress, URI uri, Map<String,String> headers, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, HandshakeChecker handshakeChecker)`
Connects to the target server using HTTP upgrade.
`static IoFuture<StreamConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, InetSocketAddress bindAddress, URI uri, Map<String,List<String>> headers, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, ExtendedHandshakeChecker handshakeChecker)`
Connects to the target server using HTTP upgrade.
`static IoFuture<SslConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, XnioSsl ssl, InetSocketAddress bindAddress, URI uri, Map<String,String> headers, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, HandshakeChecker handshakeChecker)`
Perform a HTTP upgrade that results in a SSL secured connection.
`static IoFuture<SslConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, XnioSsl ssl, InetSocketAddress bindAddress, URI uri, Map<String,List<String>> headers, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, ExtendedHandshakeChecker handshakeChecker)`
Perform a HTTP upgrade that results in a SSL secured connection.
`static <T extends StreamConnection>
IoFuture<T>`
HttpUpgrade.`performUpgrade(T connection, URI uri, Map<String,String> headers, ChannelListener<? super StreamConnection> openListener, HandshakeChecker handshakeChecker)`
Performs a HTTP upgrade on an existing connection.
`static <T extends StreamConnection>
IoFuture<T>`
HttpUpgrade.`performUpgrade(T connection, URI uri, Map<String,List<String>> headers, ChannelListener<? super StreamConnection> openListener, ExtendedHandshakeChecker handshakeChecker)`
Performs a HTTP upgrade on an existing connection.

## Uses of IoFuture in org.xnio.ssl

Methods in org.xnio.ssl that return IoFuture
Modifier and Type
Method
Description
`IoFuture<ConnectedSslStreamChannel>`
JsseXnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`abstract IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`IoFuture<SslConnection>`
JsseXnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<SslConnection>`
JsseXnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`abstract IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`abstract IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.