Uses of Interface
io.netty.util.concurrent.Future

Packages that use Future

Package	Description
io.netty.channel	The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty.channel.group	A channel registry which helps a user maintain the list of open Channels and perform bulk operations on them.
io.netty.channel.pool	Implementations and API for Channel pools.
io.netty.handler.codec.http2	Handlers for sending and receiving HTTP/2 frames.
io.netty.handler.proxy	Adds support for client connections via proxy protocols such as SOCKS and HTTP CONNECT tunneling
io.netty.handler.ssl	SSL · TLS implementation based on SSLEngine
io.netty.resolver	Resolves an arbitrary string that represents the name of an endpoint into an address.
io.netty.resolver.dns	An alternative to Java's built-in domain name lookup mechanism that resolves a domain name asynchronously, which supports the queries of an arbitrary DNS record type as well.
io.netty.util	Utility classes used across multiple packages.
io.netty.util.concurrent	Utility classes for concurrent / async tasks.

Uses of Future in io.netty.channel

Subinterfaces of Future in io.netty.channel

Modifier and Type	Interface and Description
interface	ChannelFuture The result of an asynchronous Channel I/O operation.
interface	ChannelProgressiveFuture An special ChannelFuture which is used to indicate the FileRegion transfer progress
interface	ChannelProgressivePromise Special ChannelPromise which will be notified once the associated bytes is transferring.
interface	ChannelPromise Special ChannelFuture which is writable.

Classes in io.netty.channel that implement Future

Modifier and Type	Class and Description
class	DefaultChannelProgressivePromise The default ChannelProgressivePromise implementation.
class	DefaultChannelPromise The default ChannelPromise implementation.
class	DelegatingChannelPromiseNotifier
class	VoidChannelPromise

Methods in io.netty.channel that return Future

Modifier and Type	Method and Description
Future<?>	ThreadPerChannelEventLoopGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Deprecated.
Future<?>	ThreadPerChannelEventLoopGroup.terminationFuture() Deprecated.

Method parameters in io.netty.channel with type arguments of type Future

Modifier and Type	Method and Description
ChannelPromise	DefaultChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelFuture	ChannelFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressivePromise	ChannelProgressivePromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressivePromise	DefaultChannelProgressivePromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelPromise	DelegatingChannelPromiseNotifier.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelPromise	ChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
VoidChannelPromise	VoidChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressiveFuture	ChannelProgressiveFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelPromise	DefaultChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelFuture	ChannelFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressivePromise	ChannelProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressivePromise	DefaultChannelProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelPromise	DelegatingChannelPromiseNotifier.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelPromise	ChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
VoidChannelPromise	VoidChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelProgressiveFuture	ChannelProgressiveFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)

Uses of Future in io.netty.channel.group

Subinterfaces of Future in io.netty.channel.group

Modifier and Type	Interface and Description
interface	ChannelGroupFuture The result of an asynchronous ChannelGroup operation.

Method parameters in io.netty.channel.group with type arguments of type Future

Modifier and Type	Method and Description
ChannelGroupFuture	ChannelGroupFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener)
ChannelGroupFuture	ChannelGroupFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener)

Uses of Future in io.netty.channel.pool

Methods in io.netty.channel.pool that return Future

Modifier and Type	Method and Description
Future<Channel>	ChannelPool.acquire() Acquire a Channel from this ChannelPool.
Future<Channel>	SimpleChannelPool.acquire()
Future<Channel>	ChannelPool.acquire(Promise<Channel> promise) Acquire a Channel from this ChannelPool.
Future<Channel>	FixedChannelPool.acquire(Promise<Channel> promise)
Future<Channel>	SimpleChannelPool.acquire(Promise<Channel> promise)
Future<Void>	FixedChannelPool.closeAsync() Closes the pool in an async manner.
Future<Void>	SimpleChannelPool.closeAsync() Closes the pool in an async manner.
Future<Boolean>	ChannelHealthChecker.isHealthy(Channel channel) Check if the given channel is healthy which means it can be used.
Future<Void>	ChannelPool.release(Channel channel) Release a Channel back to this ChannelPool.
Future<Void>	SimpleChannelPool.release(Channel channel)
Future<Void>	ChannelPool.release(Channel channel, Promise<Void> promise) Release a Channel back to this ChannelPool.
Future<Void>	FixedChannelPool.release(Channel channel, Promise<Void> promise)
Future<Void>	SimpleChannelPool.release(Channel channel, Promise<Void> promise)

Uses of Future in io.netty.handler.codec.http2

Methods in io.netty.handler.codec.http2 that return Future

Modifier and Type	Method and Description
Future<Void>	DefaultHttp2Connection.close(Promise<Void> promise)
Future<Void>	Http2Connection.close(Promise<Void> promise) Close this connection.
Future<Http2StreamChannel>	Http2StreamChannelBootstrap.open() Open a new Http2StreamChannel to use.
Future<Http2StreamChannel>	Http2StreamChannelBootstrap.open(Promise<Http2StreamChannel> promise) Open a new Http2StreamChannel to use and notifies the given Promise.

Uses of Future in io.netty.handler.proxy

Methods in io.netty.handler.proxy that return Future

Modifier and Type	Method and Description
Future<Channel>	ProxyHandler.connectFuture() Returns a Future that is notified when the connection to the destination has been established or the connection attempt has failed.

Uses of Future in io.netty.handler.ssl

Methods in io.netty.handler.ssl that return Future

Modifier and Type	Method and Description
Future<byte[]>	OpenSslAsyncPrivateKeyMethod.decrypt(SSLEngine engine, byte[] input) Decrypts the input with the given key and notifies the returned Future with the decrypted bytes.
Future<Channel>	SslHandler.handshakeFuture() Returns a Future that will get notified once the current TLS handshake completes.
protected Future<T>	AbstractSniHandler.lookup(ChannelHandlerContext ctx, ByteBuf clientHello)
protected abstract Future<T>	SslClientHelloHandler.lookup(ChannelHandlerContext ctx, ByteBuf clientHello) Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the SslClientHelloHandler.onLookupComplete(ChannelHandlerContext, Future) on completion.
protected abstract Future<T>	AbstractSniHandler.lookup(ChannelHandlerContext ctx, String hostname) Kicks off a lookup for the given SNI value and returns a Future which in turn will notify the AbstractSniHandler.onLookupComplete(ChannelHandlerContext, String, Future) on completion.
protected Future<SslContext>	SniHandler.lookup(ChannelHandlerContext ctx, String hostname) The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.
Future<Channel>	SslHandler.renegotiate() Performs TLS renegotiation.
Future<Channel>	SslHandler.renegotiate(Promise<Channel> promise) Performs TLS renegotiation.
Future<byte[]>	OpenSslAsyncPrivateKeyMethod.sign(SSLEngine engine, int signatureAlgorithm, byte[] input) Signs the input with the given key and notifies the returned Future with the signed bytes.
Future<Channel>	SslHandler.sslCloseFuture() Return the Future that will get notified if the inbound of the SSLEngine is closed.

Methods in io.netty.handler.ssl with parameters of type Future

Modifier and Type	Method and Description
protected void	AbstractSniHandler.onLookupComplete(ChannelHandlerContext ctx, Future<T> future)
protected abstract void	SslClientHelloHandler.onLookupComplete(ChannelHandlerContext ctx, Future<T> future) Called upon completion of the SslClientHelloHandler.lookup(ChannelHandlerContext, ByteBuf) Future.
protected void	SniHandler.onLookupComplete(ChannelHandlerContext ctx, String hostname, Future<SslContext> future)
protected abstract void	AbstractSniHandler.onLookupComplete(ChannelHandlerContext ctx, String hostname, Future<T> future) Called upon completion of the AbstractSniHandler.lookup(ChannelHandlerContext, String) Future.

Uses of Future in io.netty.resolver

Methods in io.netty.resolver that return Future

Modifier and Type	Method and Description
Future<T>	AbstractAddressResolver.resolve(SocketAddress address)
Future<T>	AddressResolver.resolve(SocketAddress address) Resolves the specified address.
Future<T>	AbstractAddressResolver.resolve(SocketAddress address, Promise<T> promise)
Future<T>	AddressResolver.resolve(SocketAddress address, Promise<T> promise) Resolves the specified address.
Future<T>	SimpleNameResolver.resolve(String inetHost)
Future<T>	NameResolver.resolve(String inetHost) Resolves the specified name into an address.
Future<T>	SimpleNameResolver.resolve(String inetHost, Promise<T> promise)
Future<T>	NameResolver.resolve(String inetHost, Promise<T> promise) Resolves the specified name into an address.
Future<List<T>>	AbstractAddressResolver.resolveAll(SocketAddress address)
Future<List<T>>	AddressResolver.resolveAll(SocketAddress address) Resolves the specified address.
Future<List<T>>	AbstractAddressResolver.resolveAll(SocketAddress address, Promise<List<T>> promise)
Future<List<T>>	AddressResolver.resolveAll(SocketAddress address, Promise<List<T>> promise) Resolves the specified address.
Future<List<T>>	SimpleNameResolver.resolveAll(String inetHost)
Future<List<T>>	NameResolver.resolveAll(String inetHost) Resolves the specified host name and port into a list of address.
Future<List<T>>	SimpleNameResolver.resolveAll(String inetHost, Promise<List<T>> promise)
Future<List<T>>	NameResolver.resolveAll(String inetHost, Promise<List<T>> promise) Resolves the specified host name and port into a list of address.

Uses of Future in io.netty.resolver.dns

Methods in io.netty.resolver.dns that return Future

Modifier and Type	Method and Description
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(DnsQuestion question) Sends a DNS query with the specified question.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(DnsQuestion question, Iterable<DnsRecord> additionals) Sends a DNS query with the specified question with additional records.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,InetSocketAddress>> promise) Sends a DNS query with the specified question.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(InetSocketAddress nameServerAddr, DnsQuestion question) Sends a DNS query with the specified question using the specified name server list.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(InetSocketAddress nameServerAddr, DnsQuestion question, Iterable<DnsRecord> additionals) Sends a DNS query with the specified question with additional records using the specified name server list.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(InetSocketAddress nameServerAddr, DnsQuestion question, Iterable<DnsRecord> additionals, Promise<AddressedEnvelope<? extends DnsResponse,InetSocketAddress>> promise) Sends a DNS query with the specified question with additional records using the specified name server list.
Future<AddressedEnvelope<DnsResponse,InetSocketAddress>>	DnsNameResolver.query(InetSocketAddress nameServerAddr, DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,InetSocketAddress>> promise) Sends a DNS query with the specified question using the specified name server list.
Future<InetAddress>	DnsNameResolver.resolve(String inetHost, Iterable<DnsRecord> additionals) Resolves the specified name into an address.
Future<InetAddress>	DnsNameResolver.resolve(String inetHost, Iterable<DnsRecord> additionals, Promise<InetAddress> promise) Resolves the specified name into an address.
Future<List<DnsRecord>>	DnsNameResolver.resolveAll(DnsQuestion question) Resolves the DnsRecords that are matched by the specified DnsQuestion.
Future<List<DnsRecord>>	DnsNameResolver.resolveAll(DnsQuestion question, Iterable<DnsRecord> additionals) Resolves the DnsRecords that are matched by the specified DnsQuestion.
Future<List<DnsRecord>>	DnsNameResolver.resolveAll(DnsQuestion question, Iterable<DnsRecord> additionals, Promise<List<DnsRecord>> promise) Resolves the DnsRecords that are matched by the specified DnsQuestion.
Future<List<InetAddress>>	DnsNameResolver.resolveAll(String inetHost, Iterable<DnsRecord> additionals) Resolves the specified host name and port into a list of address.
Future<List<InetAddress>>	DnsNameResolver.resolveAll(String inetHost, Iterable<DnsRecord> additionals, Promise<List<InetAddress>> promise) Resolves the specified host name and port into a list of address.

Uses of Future in io.netty.util

Methods in io.netty.util that return Future

Modifier and Type	Method and Description
Future<OUT>	AsyncMapping.map(IN input, Promise<OUT> promise) Returns the Future that will provide the result of the mapping.

Uses of Future in io.netty.util.concurrent

Classes in io.netty.util.concurrent with type parameters of type Future

Modifier and Type	Interface and Description
interface	GenericFutureListener<F extends Future<?>> Listens to the result of a Future.
class	PromiseAggregator<V,F extends Future<V>> Deprecated. Use PromiseCombiner(EventExecutor). GenericFutureListener implementation which consolidates multiple Futures into one, by listening to individual Futures and producing an aggregated result (success/failure) when all Futures have completed.
class	PromiseNotifier<V,F extends Future<V>> GenericFutureListener implementation which takes other Promises and notifies them on completion.

Subinterfaces of Future in io.netty.util.concurrent

Modifier and Type	Interface and Description
interface	ProgressiveFuture<V> A Future which is used to indicate the progress of an operation.
interface	ProgressivePromise<V> Special ProgressiveFuture which is writable.
interface	Promise<V> Special Future which is writable.
interface	ScheduledFuture<V> The result of a scheduled asynchronous operation.

Classes in io.netty.util.concurrent that implement Future

Modifier and Type	Class and Description
class	DefaultProgressivePromise<V>
class	DefaultPromise<V>

Methods in io.netty.util.concurrent with type parameters of type Future

Modifier and Type	Method and Description
static <V,F extends Future<V>> F	PromiseNotifier.cascade(boolean logNotifyFailure, F future, Promise<? super V> promise) Link the Future and Promise such that if the Future completes the Promise will be notified.
static <V,F extends Future<V>> F	PromiseNotifier.cascade(F future, Promise<? super V> promise) Link the Future and Promise such that if the Future completes the Promise will be notified.

Methods in io.netty.util.concurrent that return Future

Modifier and Type	Method and Description
Future<V>	Future.addListener(GenericFutureListener<? extends Future<? super V>> listener) Adds the specified listener to this future.
Future<V>	CompleteFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener)
Future<V>	Future.addListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Adds the specified listeners to this future.
Future<V>	CompleteFuture.addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
Future<V>	Future.await() Waits for this future to be completed.
Future<V>	CompleteFuture.await()
Future<V>	Future.awaitUninterruptibly() Waits for this future to be completed without interruption.
Future<V>	CompleteFuture.awaitUninterruptibly()
<V> Future<V>	AbstractEventExecutor.newFailedFuture(Throwable cause)
<V> Future<V>	EventExecutor.newFailedFuture(Throwable cause) Create a new Future which is marked as failed already.
<V> Future<V>	UnorderedThreadPoolEventExecutor.newFailedFuture(Throwable cause)
<V> Future<V>	AbstractEventExecutor.newSucceededFuture(V result)
<V> Future<V>	EventExecutor.newSucceededFuture(V result) Create a new Future which is marked as succeeded already.
<V> Future<V>	UnorderedThreadPoolEventExecutor.newSucceededFuture(V result)
Future<V>	Future.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Removes the first occurrence of the specified listener from this future.
Future<V>	CompleteFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
Future<V>	Future.removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Removes the first occurrence for each of the listeners from this future.
Future<V>	CompleteFuture.removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
Future<?>	EventExecutorGroup.shutdownGracefully() Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
Future<?>	AbstractEventExecutor.shutdownGracefully()
Future<?>	NonStickyEventExecutorGroup.shutdownGracefully()
Future<?>	AbstractEventExecutorGroup.shutdownGracefully()
Future<?>	UnorderedThreadPoolEventExecutor.shutdownGracefully()
Future<?>	EventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.
Future<?>	NonStickyEventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
Future<?>	SingleThreadEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
Future<?>	MultithreadEventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
Future<?>	GlobalEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
Future<?>	ImmediateEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
Future<?>	UnorderedThreadPoolEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)
<T> Future<T>	EventExecutorGroup.submit(Callable<T> task)
<T> Future<T>	AbstractEventExecutor.submit(Callable<T> task)
<T> Future<T>	NonStickyEventExecutorGroup.submit(Callable<T> task)
<T> Future<T>	AbstractEventExecutorGroup.submit(Callable<T> task)
<T> Future<T>	UnorderedThreadPoolEventExecutor.submit(Callable<T> task)
Future<?>	EventExecutorGroup.submit(Runnable task)
Future<?>	AbstractEventExecutor.submit(Runnable task)
Future<?>	NonStickyEventExecutorGroup.submit(Runnable task)
Future<?>	AbstractEventExecutorGroup.submit(Runnable task)
Future<?>	UnorderedThreadPoolEventExecutor.submit(Runnable task)
<T> Future<T>	EventExecutorGroup.submit(Runnable task, T result)
<T> Future<T>	AbstractEventExecutor.submit(Runnable task, T result)
<T> Future<T>	NonStickyEventExecutorGroup.submit(Runnable task, T result)
<T> Future<T>	AbstractEventExecutorGroup.submit(Runnable task, T result)
<T> Future<T>	UnorderedThreadPoolEventExecutor.submit(Runnable task, T result)
Future<V>	Future.sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
Future<V>	FailedFuture.sync()
Future<V>	CompleteFuture.sync()
Future<V>	Future.syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
Future<V>	FailedFuture.syncUninterruptibly()
Future<V>	CompleteFuture.syncUninterruptibly()
Future<?>	EventExecutorGroup.terminationFuture() Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.
Future<?>	NonStickyEventExecutorGroup.terminationFuture()
Future<?>	SingleThreadEventExecutor.terminationFuture()
Future<?>	MultithreadEventExecutorGroup.terminationFuture()
Future<?>	GlobalEventExecutor.terminationFuture()
Future<?>	ImmediateEventExecutor.terminationFuture()
Future<?>	UnorderedThreadPoolEventExecutor.terminationFuture()

Methods in io.netty.util.concurrent with parameters of type Future

Modifier and Type	Method and Description
void	PromiseCombiner.add(Future future) Adds a new future to be combined.
void	PromiseCombiner.addAll(Future... futures) Adds new futures to be combined.
static <X> void	UnaryPromiseNotifier.cascadeTo(Future<X> completedFuture, Promise<? super X> promise) Deprecated.
protected static void	DefaultPromise.notifyListener(EventExecutor eventExecutor, Future<?> future, GenericFutureListener<?> listener) Notify a listener that a future has completed.
void	UnaryPromiseNotifier.operationComplete(Future<T> future) Deprecated.

Method parameters in io.netty.util.concurrent with type arguments of type Future

Modifier and Type	Method and Description
Future<V>	Future.addListener(GenericFutureListener<? extends Future<? super V>> listener) Adds the specified listener to this future.
Promise<V>	Promise.addListener(GenericFutureListener<? extends Future<? super V>> listener)
Promise<V>	DefaultPromise.addListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressiveFuture<V>	ProgressiveFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressivePromise<V>	DefaultProgressivePromise.addListener(GenericFutureListener<? extends Future<? super V>> listener)
Future<V>	CompleteFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressivePromise<V>	ProgressivePromise.addListener(GenericFutureListener<? extends Future<? super V>> listener)
Future<V>	Future.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Removes the first occurrence of the specified listener from this future.
Promise<V>	Promise.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
Promise<V>	DefaultPromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressiveFuture<V>	ProgressiveFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressivePromise<V>	DefaultProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
Future<V>	CompleteFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
ProgressivePromise<V>	ProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener)