Promise (Netty API Reference (4.1.115.Final))

All Superinterfaces:

Future<V>

All Known Subinterfaces:

ChannelProgressivePromise, ChannelPromise, ProgressivePromise<V>

All Known Implementing Classes:

DefaultChannelProgressivePromise, DefaultChannelPromise, DefaultProgressivePromise, DefaultPromise, DelegatingChannelPromiseNotifier, VoidChannelPromise
```
public interface Promise<V>
extends Future<V>
```
Special Future which is writable.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Promise<V>`	`addListener(GenericFutureListener<? extends Future<? super V>> listener)` Adds the specified listener to this future.
`Promise<V>`	`addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Adds the specified listeners to this future.
`Promise<V>`	`await()` Waits for this future to be completed.
`Promise<V>`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`Promise<V>`	`removeListener(GenericFutureListener<? extends Future<? super V>> listener)` Removes the first occurrence of the specified listener from this future.
`Promise<V>`	`removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`Promise<V>`	`setFailure(Throwable cause)` Marks this future as a failure and notifies all listeners.
`Promise<V>`	`setSuccess(V result)` Marks this future as a success and notifies all listeners.
`boolean`	`setUncancellable()` Make this future impossible to cancel.
`Promise<V>`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`Promise<V>`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`boolean`	`tryFailure(Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`trySuccess(V result)` Marks this future as a success and notifies all listeners.

Methods inherited from interface io.netty.util.concurrent.Future
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future
get, get, isCancelled, isDone

- Method Detail
  - setSuccess
```
Promise<V> setSuccess(V result)
```
    Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
  - trySuccess
```
boolean trySuccess(V result)
```
    Marks this future as a success and notifies all listeners.
    
    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
```
Promise<V> setFailure(Throwable cause)
```
    Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
  - tryFailure
```
boolean tryFailure(Throwable cause)
```
    Marks this future as a failure and notifies all listeners.
    
    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
```
boolean setUncancellable()
```
    Make this future impossible to cancel.
    
    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.
  - addListener
```
Promise<V> addListener(GenericFutureListener<? extends Future<? super V>> 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.
  - addListeners
```
Promise<V> addListeners(GenericFutureListener<? extends Future<? super V>>... 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.
  - removeListener
```
Promise<V> removeListener(GenericFutureListener<? extends Future<? super V>> 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.
  - removeListeners
```
Promise<V> removeListeners(GenericFutureListener<? extends Future<? super V>>... 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.
  - await
```
Promise<V> await()
          throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed.
    
    Throws:
    
    InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
Promise<V> awaitUninterruptibly()
```
    Description copied from interface: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
  - sync
```
Promise<V> sync()
         throws 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.
    
    Throws:
    
    InterruptedException
  - syncUninterruptibly
```
Promise<V> 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.

Interface Promise<V>

Method Summary

Methods inherited from interface io.netty.util.concurrent.Future

Methods inherited from interface java.util.concurrent.Future

Method Detail

setSuccess

trySuccess

setFailure

tryFailure

setUncancellable

addListener

addListeners

removeListener

removeListeners

await

awaitUninterruptibly

sync

syncUninterruptibly