Class AsyncChannelPromise

  • All Implemented Interfaces:
    com.google.common.util.concurrent.ListenableFuture<java.lang.Void>, io.netty.channel.ChannelFuture, io.netty.channel.ChannelPromise, io.netty.util.concurrent.Future<java.lang.Void>, io.netty.util.concurrent.Promise<java.lang.Void>, java.util.concurrent.Future<java.lang.Void>, Awaitable, Future<java.lang.Void>, Promise<java.lang.Void>

    public class AsyncChannelPromise
    extends AsyncPromise.WithExecutor<java.lang.Void>
    implements io.netty.channel.ChannelPromise
    See AsyncPromise and ChannelPromise This class is all boiler plate, just ensuring we return ourselves and invoke the correct Promise method.
    • Constructor Detail

      • AsyncChannelPromise

        public AsyncChannelPromise​(io.netty.channel.Channel channel)
    • Method Detail

      • withListener

        public static AsyncChannelPromise withListener​(io.netty.channel.ChannelHandlerContext context,
                                                       io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
      • withListener

        public static AsyncChannelPromise withListener​(io.netty.channel.Channel channel,
                                                       io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
      • writeAndFlush

        public static io.netty.channel.ChannelFuture writeAndFlush​(io.netty.channel.ChannelHandlerContext context,
                                                                   java.lang.Object message,
                                                                   io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
      • writeAndFlush

        public static io.netty.channel.ChannelFuture writeAndFlush​(io.netty.channel.Channel channel,
                                                                   java.lang.Object message,
                                                                   io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
      • writeAndFlush

        public static io.netty.channel.ChannelFuture writeAndFlush​(io.netty.channel.ChannelHandlerContext context,
                                                                   java.lang.Object message)
      • writeAndFlush

        public static io.netty.channel.ChannelFuture writeAndFlush​(io.netty.channel.Channel channel,
                                                                   java.lang.Object message)
      • channel

        public io.netty.channel.Channel channel()
        Specified by:
        channel in interface io.netty.channel.ChannelFuture
        Specified by:
        channel in interface io.netty.channel.ChannelPromise
      • isVoid

        public boolean isVoid()
        Specified by:
        isVoid in interface io.netty.channel.ChannelFuture
      • setSuccess

        public io.netty.channel.ChannelPromise setSuccess()
        Specified by:
        setSuccess in interface io.netty.channel.ChannelPromise
      • setSuccess

        public AsyncChannelPromise setSuccess​(java.lang.Void v)
        Description copied from class: AsyncPromise
        Complete the promise successfully if not already complete
        Specified by:
        setSuccess in interface io.netty.channel.ChannelPromise
        Specified by:
        setSuccess in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        setSuccess in interface Promise<java.lang.Void>
        Overrides:
        setSuccess in class AsyncPromise<java.lang.Void>
      • trySuccess

        public boolean trySuccess()
        Specified by:
        trySuccess in interface io.netty.channel.ChannelPromise
      • setFailure

        public AsyncChannelPromise setFailure​(java.lang.Throwable throwable)
        Description copied from class: AsyncPromise
        Complete the promise abnormally if not already complete
        Specified by:
        setFailure in interface io.netty.channel.ChannelPromise
        Specified by:
        setFailure in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        setFailure in interface Promise<java.lang.Void>
        Overrides:
        setFailure in class AsyncPromise<java.lang.Void>
      • sync

        public AsyncChannelPromise sync()
                                 throws java.lang.InterruptedException
        Description copied from class: AsyncPromise
        waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces
        Specified by:
        sync in interface io.netty.channel.ChannelFuture
        Specified by:
        sync in interface io.netty.channel.ChannelPromise
        Specified by:
        sync in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        sync in interface Future<java.lang.Void>
        Specified by:
        sync in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        sync in interface Promise<java.lang.Void>
        Overrides:
        sync in class AsyncPromise<java.lang.Void>
        Throws:
        java.lang.InterruptedException
      • syncUninterruptibly

        public AsyncChannelPromise syncUninterruptibly()
        Description copied from class: AsyncPromise
        waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces
        Specified by:
        syncUninterruptibly in interface io.netty.channel.ChannelFuture
        Specified by:
        syncUninterruptibly in interface io.netty.channel.ChannelPromise
        Specified by:
        syncUninterruptibly in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        syncUninterruptibly in interface Future<java.lang.Void>
        Specified by:
        syncUninterruptibly in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        syncUninterruptibly in interface Promise<java.lang.Void>
        Overrides:
        syncUninterruptibly in class AsyncPromise<java.lang.Void>
      • await

        public AsyncChannelPromise await()
                                  throws java.lang.InterruptedException
        Description copied from class: AsyncPromise
        Wait for this promise to complete
        Specified by:
        await in interface Awaitable
        Specified by:
        await in interface io.netty.channel.ChannelFuture
        Specified by:
        await in interface io.netty.channel.ChannelPromise
        Specified by:
        await in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        await in interface Future<java.lang.Void>
        Specified by:
        await in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        await in interface Promise<java.lang.Void>
        Overrides:
        await in class AsyncPromise<java.lang.Void>
        Throws:
        java.lang.InterruptedException - if interrupted
      • awaitUninterruptibly

        public AsyncChannelPromise awaitUninterruptibly()
        Description copied from class: AsyncPromise
        Wait uninterruptibly for this promise to complete
        Specified by:
        awaitUninterruptibly in interface Awaitable
        Specified by:
        awaitUninterruptibly in interface io.netty.channel.ChannelFuture
        Specified by:
        awaitUninterruptibly in interface io.netty.channel.ChannelPromise
        Specified by:
        awaitUninterruptibly in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        awaitUninterruptibly in interface Future<java.lang.Void>
        Specified by:
        awaitUninterruptibly in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        awaitUninterruptibly in interface Promise<java.lang.Void>
        Overrides:
        awaitUninterruptibly in class AsyncPromise<java.lang.Void>
      • addListener

        public AsyncChannelPromise addListener​(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
        Description copied from class: AbstractFuture
        Add a listener to be invoked once this future completes. Listeners are submitted to AbstractFuture.notifyExecutor() in the order they are added (or the specified executor in the case of AbstractFuture.addListener(Runnable, Executor). if AbstractFuture.notifyExecutor() is unset, they are invoked in the order they are added. The ordering holds across all variants of this method.
        Specified by:
        addListener in interface io.netty.channel.ChannelFuture
        Specified by:
        addListener in interface io.netty.channel.ChannelPromise
        Specified by:
        addListener in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        addListener in interface Future<java.lang.Void>
        Specified by:
        addListener in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        addListener in interface Promise<java.lang.Void>
        Overrides:
        addListener in class AsyncPromise<java.lang.Void>
      • addListeners

        public AsyncChannelPromise addListeners​(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>>... listeners)
        Specified by:
        addListeners in interface io.netty.channel.ChannelFuture
        Specified by:
        addListeners in interface io.netty.channel.ChannelPromise
        Specified by:
        addListeners in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        addListeners in interface Future<java.lang.Void>
        Specified by:
        addListeners in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        addListeners in interface Promise<java.lang.Void>
        Overrides:
        addListeners in class AsyncPromise<java.lang.Void>
      • removeListener

        public AsyncChannelPromise removeListener​(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>> listener)
        Specified by:
        removeListener in interface io.netty.channel.ChannelFuture
        Specified by:
        removeListener in interface io.netty.channel.ChannelPromise
        Specified by:
        removeListener in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        removeListener in interface Future<java.lang.Void>
        Specified by:
        removeListener in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        removeListener in interface Promise<java.lang.Void>
        Overrides:
        removeListener in class AsyncPromise<java.lang.Void>
      • removeListeners

        public AsyncChannelPromise removeListeners​(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super java.lang.Void>>... listeners)
        Specified by:
        removeListeners in interface io.netty.channel.ChannelFuture
        Specified by:
        removeListeners in interface io.netty.channel.ChannelPromise
        Specified by:
        removeListeners in interface io.netty.util.concurrent.Future<java.lang.Void>
        Specified by:
        removeListeners in interface Future<java.lang.Void>
        Specified by:
        removeListeners in interface io.netty.util.concurrent.Promise<java.lang.Void>
        Specified by:
        removeListeners in interface Promise<java.lang.Void>
        Overrides:
        removeListeners in class AsyncPromise<java.lang.Void>
      • unvoid

        public io.netty.channel.ChannelPromise unvoid()
        Specified by:
        unvoid in interface io.netty.channel.ChannelPromise