DelegatingChannelPromiseNotifier (Netty API Reference (4.1.33.Final))

java.lang.Object
- io.netty.channel.DelegatingChannelPromiseNotifier

All Implemented Interfaces:

ChannelFuture, ChannelFutureListener, ChannelPromise, GenericFutureListener<ChannelFuture>, Promise<java.lang.Void>, java.util.concurrent.Future<java.lang.Void>, java.util.EventListener
```
@UnstableApi
public final class DelegatingChannelPromiseNotifier
extends java.lang.Object
implements ChannelPromise, ChannelFutureListener
```

Field Summary
- Fields inherited from interface io.netty.channel.ChannelFutureListener
  CLOSE, CLOSE_ON_FAILURE, FIRE_EXCEPTION_ON_FAILURE

Constructor Summary

Constructors
Constructor and Description
`DelegatingChannelPromiseNotifier(ChannelPromise delegate)`
`DelegatingChannelPromiseNotifier(ChannelPromise delegate, boolean logNotifyFailure)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChannelPromise`	`addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` Adds the specified listener to this future.
`ChannelPromise`	`addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` Adds the specified listeners to this future.
`ChannelPromise`	`await()` Waits for this future to be completed.
`boolean`	`await(long timeoutMillis)` Waits for this future to be completed within the specified time limit.
`boolean`	`await(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit.
`ChannelPromise`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`boolean`	`awaitUninterruptibly(long timeoutMillis)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`cancel(boolean mayInterruptIfRunning)` If the cancellation was successful it will fail the future with an `CancellationException`.
`java.lang.Throwable`	`cause()` Returns the cause of the failed I/O operation if the I/O operation has failed.
`Channel`	`channel()` Returns a channel where the I/O operation associated with this future takes place.
`java.lang.Void`	`get()`
`java.lang.Void`	`get(long timeout, java.util.concurrent.TimeUnit unit)`
`java.lang.Void`	`getNow()` Return the result without blocking.
`boolean`	`isCancellable()` returns `true` if and only if the operation can be cancelled via `Future.cancel(boolean)`.
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`boolean`	`isSuccess()` Returns `true` if and only if the I/O operation was completed successfully.
`boolean`	`isVoid()` Returns `true` if this `ChannelFuture` is a void future and so not allow to call any of the following methods: `ChannelFuture.addListener(GenericFutureListener)` `ChannelFuture.addListeners(GenericFutureListener[])` `ChannelFuture.await()` `Future.await(long, TimeUnit)` ()} `Future.await(long)` ()} `ChannelFuture.awaitUninterruptibly()` `ChannelFuture.sync()` `ChannelFuture.syncUninterruptibly()`
`void`	`operationComplete(ChannelFuture future)` Invoked when the operation associated with the `Future` has been completed.
`ChannelPromise`	`removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` Removes the first occurrence of the specified listener from this future.
`ChannelPromise`	`removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`ChannelPromise`	`setFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`ChannelPromise`	`setSuccess()`
`ChannelPromise`	`setSuccess(java.lang.Void result)` Marks this future as a success and notifies all listeners.
`boolean`	`setUncancellable()` Make this future impossible to cancel.
`ChannelPromise`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`ChannelPromise`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`boolean`	`tryFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`trySuccess()`
`boolean`	`trySuccess(java.lang.Void result)` Marks this future as a success and notifies all listeners.
`ChannelPromise`	`unvoid()` Returns a new `ChannelPromise` if `ChannelFuture.isVoid()` returns `true` otherwise itself.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DelegatingChannelPromiseNotifier
```
public DelegatingChannelPromiseNotifier(ChannelPromise delegate)
```
  - DelegatingChannelPromiseNotifier
```
public DelegatingChannelPromiseNotifier(ChannelPromise delegate,
                                        boolean logNotifyFailure)
```
- Method Detail
  - operationComplete
```
public void operationComplete(ChannelFuture future)
                       throws java.lang.Exception
```
    Description copied from interface: GenericFutureListener
    
    Invoked when the operation associated with the Future has been completed.
    
    Specified by:
    
    operationComplete in interface GenericFutureListener<ChannelFuture>
    
    Parameters:
    
    future - the source Future which called this callback
    
    Throws:
    
    java.lang.Exception
  - channel
```
public Channel channel()
```
    Description copied from interface: ChannelFuture
    
    Returns a channel where the I/O operation associated with this future takes place.
    
    Specified by:
    
    channel in interface ChannelFuture
    
    Specified by:
    
    channel in interface ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess(java.lang.Void result)
```
    Description copied from interface: Promise
    
    Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
    
    Specified by:
    
    setSuccess in interface ChannelPromise
    
    Specified by:
    
    setSuccess in interface Promise<java.lang.Void>
  - setSuccess
```
public ChannelPromise setSuccess()
```
    Specified by:
    
    setSuccess in interface ChannelPromise
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess in interface ChannelPromise
  - trySuccess
```
public boolean trySuccess(java.lang.Void result)
```
    Description copied from interface: Promise
    
    Marks this future as a success and notifies all listeners.
    
    Specified by:
    
    trySuccess in interface Promise<java.lang.Void>
    
    Returns:
    
    true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.
  - setFailure
```
public ChannelPromise setFailure(java.lang.Throwable cause)
```
    Description copied from interface: Promise
    
    Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
    
    Specified by:
    
    setFailure in interface ChannelPromise
    
    Specified by:
    
    setFailure in interface Promise<java.lang.Void>
  - addListener
```
public ChannelPromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    Description copied from interface: Future
    
    Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.
    
    Specified by:
    
    addListener in interface ChannelFuture
    
    Specified by:
    
    addListener in interface ChannelPromise
    
    Specified by:
    
    addListener in interface Promise<java.lang.Void>
  - addListeners
```
public ChannelPromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    Description copied from interface: Future
    
    Adds the specified listeners to this future. The specified listeners are notified when this future is done. If this future is already completed, the specified listeners are notified immediately.
    
    Specified by:
    
    addListeners in interface ChannelFuture
    
    Specified by:
    
    addListeners in interface ChannelPromise
    
    Specified by:
    
    addListeners in interface Promise<java.lang.Void>
  - removeListener
```
public ChannelPromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    Description copied from interface: Future
    
    Removes the first occurrence of the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.
    
    Specified by:
    
    removeListener in interface ChannelFuture
    
    Specified by:
    
    removeListener in interface ChannelPromise
    
    Specified by:
    
    removeListener in interface Promise<java.lang.Void>
  - removeListeners
```
public ChannelPromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    Description copied from interface: Future
    
    Removes the first occurrence for each of the listeners from this future. The specified listeners are no longer notified when this future is done. If the specified listeners are not associated with this future, this method does nothing and returns silently.
    
    Specified by:
    
    removeListeners in interface ChannelFuture
    
    Specified by:
    
    removeListeners in interface ChannelPromise
    
    Specified by:
    
    removeListeners in interface Promise<java.lang.Void>
  - tryFailure
```
public boolean tryFailure(java.lang.Throwable cause)
```
    Description copied from interface: Promise
    
    Marks this future as a failure and notifies all listeners.
    
    Specified by:
    
    tryFailure in interface Promise<java.lang.Void>
    
    Returns:
    
    true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.
  - setUncancellable
```
public boolean setUncancellable()
```
    Description copied from interface: Promise
    
    Make this future impossible to cancel.
    
    Specified by:
    
    setUncancellable in interface Promise<java.lang.Void>
    
    Returns:
    
    true if and only if successfully marked this future as uncancellable or it is already done without being cancelled. false if this future has been cancelled already.
  - await
```
public ChannelPromise await()
                     throws java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed.
    
    Specified by:
    
    await in interface ChannelFuture
    
    Specified by:
    
    await in interface ChannelPromise
    
    Specified by:
    
    await in interface Promise<java.lang.Void>
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public ChannelPromise awaitUninterruptibly()
```
    Description copied from interface: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
    
    Specified by:
    
    awaitUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    awaitUninterruptibly in interface Promise<java.lang.Void>
  - isVoid
```
public boolean isVoid()
```
    Description copied from interface: ChannelFuture
    Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods:
    Specified by:
    
    isVoid in interface ChannelFuture
  - unvoid
```
public ChannelPromise unvoid()
```
    Description copied from interface: ChannelPromise
    
    Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.
    
    Specified by:
    
    unvoid in interface ChannelPromise
  - await
```
public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - await
```
public boolean await(long timeoutMillis)
              throws java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeout,
                                    java.util.concurrent.TimeUnit unit)
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeoutMillis)
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
  - getNow
```
public java.lang.Void getNow()
```
    Description copied from interface: Future
    
    Return the result without blocking. If the future is not done yet this will return null. As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not relay on the returned null value.
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    Description copied from interface: Future
    
    If the cancellation was successful it will fail the future with an CancellationException.
    
    Specified by:
    
    cancel in interface java.util.concurrent.Future<java.lang.Void>
  - isCancelled
```
public boolean isCancelled()
```
    Specified by:
    
    isCancelled in interface java.util.concurrent.Future<java.lang.Void>
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface java.util.concurrent.Future<java.lang.Void>
  - get
```
public java.lang.Void get()
                   throws java.lang.InterruptedException,
                          java.util.concurrent.ExecutionException
```
    Specified by:
    
    get in interface java.util.concurrent.Future<java.lang.Void>
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.ExecutionException
  - get
```
public java.lang.Void get(long timeout,
                          java.util.concurrent.TimeUnit unit)
                   throws java.lang.InterruptedException,
                          java.util.concurrent.ExecutionException,
                          java.util.concurrent.TimeoutException
```
    Specified by:
    
    get in interface java.util.concurrent.Future<java.lang.Void>
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.ExecutionException
    
    java.util.concurrent.TimeoutException
  - sync
```
public ChannelPromise sync()
                    throws java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
    
    Specified by:
    
    sync in interface ChannelFuture
    
    Specified by:
    
    sync in interface ChannelPromise
    
    Specified by:
    
    sync in interface Promise<java.lang.Void>
    
    Throws:
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public ChannelPromise syncUninterruptibly()
```
    Description copied from interface: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
    
    Specified by:
    
    syncUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    syncUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    syncUninterruptibly in interface Promise<java.lang.Void>
  - isSuccess
```
public boolean isSuccess()
```
    Description copied from interface: Future
    
    Returns true if and only if the I/O operation was completed successfully.
  - isCancellable
```
public boolean isCancellable()
```
    Description copied from interface: Future
    
    returns true if and only if the operation can be cancelled via Future.cancel(boolean).
  - cause
```
public java.lang.Throwable cause()
```
    Description copied from interface: Future
    
    Returns the cause of the failed I/O operation if the I/O operation has failed.
    
    Returns:
    
    the cause of the failure. null if succeeded or this future is not completed yet.

Class DelegatingChannelPromiseNotifier

Field Summary

Fields inherited from interface io.netty.channel.ChannelFutureListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DelegatingChannelPromiseNotifier

DelegatingChannelPromiseNotifier

Method Detail

operationComplete

channel

setSuccess

setSuccess

trySuccess

trySuccess

setFailure

addListener

addListeners

removeListener

removeListeners

tryFailure

setUncancellable

await

awaitUninterruptibly

isVoid

unvoid

await

await

awaitUninterruptibly

awaitUninterruptibly

getNow

cancel

isCancelled

isDone

get

get

sync

syncUninterruptibly

isSuccess

isCancellable

cause