Uses of Interface
io.netty.util.concurrent.Future
Packages that use Future
Package
Description
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
A channel registry which helps a user maintain the list of open
Channels and perform bulk operations on them.Implementations and API for
Channel pools.Handlers for sending and receiving HTTP/2 frames.
HTTP/3 implementation.
QUIC implementation
Adds support for client connections via proxy protocols such as
SOCKS and
HTTP CONNECT tunneling
Resolves an arbitrary string that represents the name of an endpoint into an address.
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.
Utility classes used across multiple packages.
Utility classes for concurrent / async tasks.
-
Uses of Future in io.netty.channel
Subinterfaces of Future in io.netty.channelModifier and TypeInterfaceDescriptioninterfaceThe result of an asynchronousChannelI/O operation.interfaceAn specialChannelFuturewhich is used to indicate theFileRegiontransfer progressinterfaceSpecialChannelPromisewhich will be notified once the associated bytes is transferring.interfaceSpecialChannelFuturewhich is writable.Classes in io.netty.channel that implement FutureModifier and TypeClassDescriptionclassThe defaultChannelProgressivePromiseimplementation.classThe defaultChannelPromiseimplementation.final classfinal classMethods in io.netty.channel that return FutureModifier and TypeMethodDescriptiondefault Future<IoRegistration> final Future<IoRegistration> final Future<IoRegistration> final Future<?> ManualIoEventLoop.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> ThreadPerChannelEventLoopGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Deprecated.final Future<?> ManualIoEventLoop.terminationFuture()Future<?> ThreadPerChannelEventLoopGroup.terminationFuture()Deprecated.Method parameters in io.netty.channel with type arguments of type FutureModifier and TypeMethodDescriptionChannelFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelProgressiveFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelProgressivePromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener) DefaultChannelProgressivePromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener) DefaultChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener) DelegatingChannelPromiseNotifier.addListener(GenericFutureListener<? extends Future<? super Void>> listener) VoidChannelPromise.addListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelProgressiveFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) DefaultChannelProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) DefaultChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) DelegatingChannelPromiseNotifier.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) VoidChannelPromise.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) -
Uses of Future in io.netty.channel.group
Subinterfaces of Future in io.netty.channel.groupModifier and TypeInterfaceDescriptioninterfaceThe result of an asynchronousChannelGroupoperation.Method parameters in io.netty.channel.group with type arguments of type FutureModifier and TypeMethodDescriptionChannelGroupFuture.addListener(GenericFutureListener<? extends Future<? super Void>> listener) ChannelGroupFuture.removeListener(GenericFutureListener<? extends Future<? super Void>> listener) -
Uses of Future in io.netty.channel.pool
Methods in io.netty.channel.pool that return FutureModifier and TypeMethodDescriptionChannelPool.acquire()Acquire aChannelfrom thisChannelPool.Acquire aChannelfrom thisChannelPool.SimpleChannelPool.acquire()FixedChannelPool.closeAsync()Closes the pool in an async manner.SimpleChannelPool.closeAsync()Closes the pool in an async manner.Check if the given channel is healthy which means it can be used.Release aChannelback to thisChannelPool.Release aChannelback to thisChannelPool. -
Uses of Future in io.netty.handler.codec.http2
Methods in io.netty.handler.codec.http2 that return FutureModifier and TypeMethodDescriptionClose this connection.Http2StreamChannelBootstrap.open()Open a newHttp2StreamChannelto use.Http2StreamChannelBootstrap.open(Promise<Http2StreamChannel> promise) Open a newHttp2StreamChannelto use and notifies the givenPromise. -
Uses of Future in io.netty.handler.codec.http3
Methods in io.netty.handler.codec.http3 that return FutureModifier and TypeMethodDescriptionHttp3ServerPushStreamManager.newPushStream(long pushId, @Nullable ChannelHandler handler) Returns a new HTTP/3 push-stream that will use the givenChannelHandlerto dispatchHttp3PushStreamFrames too.static Future<QuicStreamChannel> Http3.newRequestStream(QuicChannel channel, ChannelHandler handler) Returns a new HTTP/3 request-stream that will use the givenChannelHandlerto dispatchHttp3RequestStreamFrames too. -
Uses of Future in io.netty.handler.codec.quic
Methods in io.netty.handler.codec.quic that return FutureModifier and TypeMethodDescriptiondefault Future<QuicConnectionPathStats> QuicChannel.collectPathStats(int pathIdx) Collects statistics about the path of the connection and notifies theFutureonce done.QuicChannel.collectPathStats(int pathIdx, Promise<QuicConnectionPathStats> promise) Collects statistics about the path of the connection and notifies thePromiseonce done.default Future<QuicConnectionStats> QuicChannel.collectStats()Collects statistics about the connection and notifies theFutureonce done.QuicChannel.collectStats(Promise<QuicConnectionStats> promise) Collects statistics about the connection and notifies thePromiseonce done.QuicChannelBootstrap.connect()Connects aQuicChannelto the remote peer and notifies the future once done.QuicChannelBootstrap.connect(Promise<QuicChannel> promise) Connects aQuicChannelto the remote peer and notifies the promise once done.QuicStreamChannelBootstrap.create()Creates a newQuicStreamChanneland notifies theFuture.QuicStreamChannelBootstrap.create(Promise<QuicStreamChannel> promise) Creates a newQuicStreamChanneland notifies theFuture.default Future<QuicStreamChannel> QuicChannel.createStream(QuicStreamType type, @Nullable ChannelHandler handler) Creates a stream that is using thisQuicChanneland notifies theFutureonce done.QuicChannel.createStream(QuicStreamType type, @Nullable ChannelHandler handler, Promise<QuicStreamChannel> promise) Creates a stream that is using thisQuicChanneland notifies thePromiseonce done.Future<byte[]> Decrypts the input with the given key and notifies the returnedFuturewith the decrypted bytes.Future<byte[]> Signs the input with the given key and notifies the returnedFuturewith the signed bytes. -
Uses of Future in io.netty.handler.proxy
Methods in io.netty.handler.proxy that return FutureModifier and TypeMethodDescriptionProxyHandler.connectFuture()Returns aFuturethat 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 FutureModifier and TypeMethodDescriptionFuture<byte[]> Decrypts the input with the given key and notifies the returnedFuturewith the decrypted bytes.SslHandler.handshakeFuture()Returns aFuturethat will get notified once the current TLS handshake completes.AbstractSniHandler.lookup(ChannelHandlerContext ctx, ByteBuf clientHello) AbstractSniHandler.lookup(ChannelHandlerContext ctx, String hostname) Kicks off a lookup for the given SNI value and returns aFuturewhich in turn will notify theAbstractSniHandler.onLookupComplete(ChannelHandlerContext, String, Future)on completion.protected Future<SslContext> SniHandler.lookup(ChannelHandlerContext ctx, String hostname) The default implementation will simply callAsyncMapping.map(Object, Promise)but users can override this method to implement custom behavior.SslClientHelloHandler.lookup(ChannelHandlerContext ctx, ByteBuf clientHello) Kicks off a lookup for the givenClientHelloand returns aFuturewhich in turn will notify theSslClientHelloHandler.onLookupComplete(ChannelHandlerContext, Future)on completion.SslHandler.renegotiate()Performs TLS renegotiation.SslHandler.renegotiate(Promise<Channel> promise) Performs TLS renegotiation.Future<byte[]> Signs the input with the given key and notifies the returnedFuturewith the signed bytes.SslHandler.sslCloseFuture()Methods in io.netty.handler.ssl with parameters of type FutureModifier and TypeMethodDescriptionprotected voidAbstractSniHandler.onLookupComplete(ChannelHandlerContext ctx, Future<T> future) protected abstract voidAbstractSniHandler.onLookupComplete(ChannelHandlerContext ctx, String hostname, Future<T> future) Called upon completion of theAbstractSniHandler.lookup(ChannelHandlerContext, String)Future.protected final voidSniHandler.onLookupComplete(ChannelHandlerContext ctx, String hostname, Future<SslContext> future) protected abstract voidSslClientHelloHandler.onLookupComplete(ChannelHandlerContext ctx, Future<T> future) Called upon completion of theSslClientHelloHandler.lookup(ChannelHandlerContext, ByteBuf)Future. -
Uses of Future in io.netty.resolver
Methods in io.netty.resolver that return FutureModifier and TypeMethodDescriptionAbstractAddressResolver.resolve(SocketAddress address) AbstractAddressResolver.resolve(SocketAddress address, Promise<T> promise) AddressResolver.resolve(SocketAddress address) Resolves the specified address.AddressResolver.resolve(SocketAddress address, Promise<T> promise) Resolves the specified address.Resolves the specified name into an address.Resolves the specified name into an address.AbstractAddressResolver.resolveAll(SocketAddress address) AbstractAddressResolver.resolveAll(SocketAddress address, Promise<List<T>> promise) AddressResolver.resolveAll(SocketAddress address) Resolves the specified address.AddressResolver.resolveAll(SocketAddress address, Promise<List<T>> promise) Resolves the specified address.NameResolver.resolveAll(String inetHost) Resolves the specified host name and port into a list of address.NameResolver.resolveAll(String inetHost, Promise<List<T>> promise) Resolves the specified host name and port into a list of address.SimpleNameResolver.resolveAll(String inetHost) SimpleNameResolver.resolveAll(String inetHost, Promise<List<T>> promise) -
Uses of Future in io.netty.resolver.dns
Methods in io.netty.resolver.dns that return FutureModifier and TypeMethodDescriptionDnsNameResolver.query(DnsQuestion question) Sends a DNS query with the specified question.DnsNameResolver.query(DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse, InetSocketAddress>> promise) Sends a DNS query with the specified question.DnsNameResolver.query(DnsQuestion question, Iterable<DnsRecord> additionals) Sends a DNS query with the specified question with additional records.DnsNameResolver.query(InetSocketAddress nameServerAddr, DnsQuestion question) Sends a DNS query with the specified question using the specified name server list.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.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.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.final Future<InetAddress> Resolves the specified name into an address.final Future<InetAddress> DnsNameResolver.resolve(String inetHost, Iterable<DnsRecord> additionals, Promise<InetAddress> promise) Resolves the specified name into an address.DnsNameResolver.resolveAll(DnsQuestion question) Resolves theDnsRecords that are matched by the specifiedDnsQuestion.DnsNameResolver.resolveAll(DnsQuestion question, Iterable<DnsRecord> additionals) Resolves theDnsRecords that are matched by the specifiedDnsQuestion.DnsNameResolver.resolveAll(DnsQuestion question, Iterable<DnsRecord> additionals, Promise<List<DnsRecord>> promise) Resolves theDnsRecords that are matched by the specifiedDnsQuestion.final Future<List<InetAddress>> DnsNameResolver.resolveAll(String inetHost, Iterable<DnsRecord> additionals) Resolves the specified host name and port into a list of address.final 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 -
Uses of Future in io.netty.util.concurrent
Classes in io.netty.util.concurrent with type parameters of type FutureModifier and TypeInterfaceDescriptioninterfaceGenericFutureListener<F extends Future<?>>Listens to the result of aFuture.classPromiseAggregator<V, F extends Future<V>>Deprecated.classPromiseNotifier<V, F extends Future<V>>GenericFutureListenerimplementation which takes otherPromises and notifies them on completion.Subinterfaces of Future in io.netty.util.concurrentModifier and TypeInterfaceDescriptioninterfaceAFuturewhich is used to indicate the progress of an operation.interfaceSpecialProgressiveFuturewhich is writable.interfacePromise<V>SpecialFuturewhich is writable.interfaceThe result of a scheduled asynchronous operation.Classes in io.netty.util.concurrent that implement FutureModifier and TypeClassDescriptionclassAbstractFutureimplementation which does not allow for cancellation.classclassclassfinal classFailedFuture<V>TheCompleteFuturewhich is failed already.final classTheCompleteFuturewhich is succeeded already.Subinterfaces with type arguments of type Future in io.netty.util.concurrentModifier and TypeInterfaceDescriptioninterfaceA subtype ofGenericFutureListenerthat hides type parameter for convenience.Methods in io.netty.util.concurrent with type parameters of type FutureModifier and TypeMethodDescriptionstatic <V, F extends Future<V>>
Fstatic <V, F extends Future<V>>
FMethods in io.netty.util.concurrent that return FutureModifier and TypeMethodDescriptionCompleteFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener) Future.addListener(GenericFutureListener<? extends Future<? super V>> listener) Adds the specified listener to this future.CompleteFuture.addListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Future.addListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Adds the specified listeners to this future.CompleteFuture.await()Future.await()Waits for this future to be completed.CompleteFuture.awaitUninterruptibly()Future.awaitUninterruptibly()Waits for this future to be completed without interruption.default <V> Future<V> EventExecutor.newFailedFuture(Throwable cause) Create a newFuturewhich is marked as failed already.<V> Future<V> UnorderedThreadPoolEventExecutor.newFailedFuture(Throwable cause) Deprecated.default <V> Future<V> EventExecutor.newSucceededFuture(V result) Create a newFuturewhich is marked as succeeded already.<V> Future<V> UnorderedThreadPoolEventExecutor.newSucceededFuture(V result) Deprecated.CompleteFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Future.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Removes the first occurrence of the specified listener from this future.CompleteFuture.removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Future.removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners) Removes the first occurrence for each of the listeners from this future.Future<?> AbstractEventExecutor.shutdownGracefully()Future<?> AbstractEventExecutorGroup.shutdownGracefully()Future<?> EventExecutorGroup.shutdownGracefully()Shortcut method forEventExecutorGroup.shutdownGracefully(long, long, TimeUnit)with sensible default values.Future<?> EventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.Future<?> GlobalEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> ImmediateEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> MultithreadEventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> NonStickyEventExecutorGroup.shutdownGracefully()Future<?> NonStickyEventExecutorGroup.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> SingleThreadEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Future<?> UnorderedThreadPoolEventExecutor.shutdownGracefully()Deprecated.Future<?> UnorderedThreadPoolEventExecutor.shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Deprecated.Future<?> <T> Future<T> <T> Future<T> Future<?> <T> Future<T> <T> Future<T> Future<?> <T> Future<T> <T> Future<T> Future<?> <T> Future<T> <T> Future<T> Future<?> Deprecated.<T> Future<T> Deprecated.<T> Future<T> Deprecated.CompleteFuture.sync()FailedFuture.sync()Future.sync()Waits for this future until it is done, and rethrows the cause of the failure if this future failed.CompleteFuture.syncUninterruptibly()FailedFuture.syncUninterruptibly()Future.syncUninterruptibly()Waits for this future until it is done, and rethrows the cause of the failure if this future failed.Future<?> EventExecutorGroup.terminationFuture()Returns theFuturewhich is notified when allEventExecutors managed by thisEventExecutorGrouphave been terminated.Future<?> GlobalEventExecutor.terminationFuture()Future<?> ImmediateEventExecutor.terminationFuture()Future<?> MultithreadEventExecutorGroup.terminationFuture()Future<?> NonStickyEventExecutorGroup.terminationFuture()Future<?> SingleThreadEventExecutor.terminationFuture()Future<?> UnorderedThreadPoolEventExecutor.terminationFuture()Deprecated.Methods in io.netty.util.concurrent with parameters of type FutureModifier and TypeMethodDescriptionvoidAdds a new future to be combined.voidAdds new futures to be combined.static <X> voidDeprecated.protected static voidDefaultPromise.notifyListener(EventExecutor eventExecutor, Future<?> future, GenericFutureListener<?> listener) Notify a listener that a future has completed.voidUnaryPromiseNotifier.operationComplete(Future<T> future) Deprecated.Method parameters in io.netty.util.concurrent with type arguments of type FutureModifier and TypeMethodDescriptionCompleteFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener) DefaultProgressivePromise.addListener(GenericFutureListener<? extends Future<? super V>> listener) DefaultPromise.addListener(GenericFutureListener<? extends Future<? super V>> listener) Future.addListener(GenericFutureListener<? extends Future<? super V>> listener) Adds the specified listener to this future.ProgressiveFuture.addListener(GenericFutureListener<? extends Future<? super V>> listener) ProgressivePromise.addListener(GenericFutureListener<? extends Future<? super V>> listener) Promise.addListener(GenericFutureListener<? extends Future<? super V>> listener) CompleteFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener) DefaultProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener) DefaultPromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Future.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Removes the first occurrence of the specified listener from this future.ProgressiveFuture.removeListener(GenericFutureListener<? extends Future<? super V>> listener) ProgressivePromise.removeListener(GenericFutureListener<? extends Future<? super V>> listener) Promise.removeListener(GenericFutureListener<? extends Future<? super V>> listener)
PromiseCombiner(EventExecutor).