ProgressivePromise (Netty API Reference (4.0.56.Final))

All Superinterfaces:

java.util.concurrent.Future<V>, ProgressiveFuture<V>, Promise<V>

All Known Subinterfaces:

ChannelProgressivePromise

All Known Implementing Classes:

DefaultChannelProgressivePromise, DefaultProgressivePromise
```
public interface ProgressivePromise<V>
extends Promise<V>, ProgressiveFuture<V>
```
Special ProgressiveFuture which is writable.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProgressivePromise<V>`	`addListener(GenericFutureListener<? extends Future<? super V>> listener)` Adds the specified listener to this future.
`ProgressivePromise<V>`	`addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Adds the specified listeners to this future.
`ProgressivePromise<V>`	`await()` Waits for this future to be completed.
`ProgressivePromise<V>`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`ProgressivePromise<V>`	`removeListener(GenericFutureListener<? extends Future<? super V>> listener)` Removes the first occurrence of the specified listener from this future.
`ProgressivePromise<V>`	`removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`ProgressivePromise<V>`	`setFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`ProgressivePromise<V>`	`setProgress(long progress, long total)` Sets the current progress of the operation and notifies the listeners that implement `GenericProgressiveFutureListener`.
`ProgressivePromise<V>`	`setSuccess(V result)` Marks this future as a success and notifies all listeners.
`ProgressivePromise<V>`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`ProgressivePromise<V>`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`boolean`	`tryProgress(long progress, long total)` Tries to set the current progress of the operation and notifies the listeners that implement `GenericProgressiveFutureListener`.

Methods inherited from interface io.netty.util.concurrent.Promise
setUncancellable, tryFailure, trySuccess

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
  - setProgress
```
ProgressivePromise<V> setProgress(long progress,
                                  long total)
```
    Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.
  - tryProgress
```
boolean tryProgress(long progress,
                    long total)
```
    Tries to set the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener. If the operation is already complete or the progress is out of range, this method does nothing but returning false.
  - setSuccess
```
ProgressivePromise<V> setSuccess(V 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 Promise<V>
  - setFailure
```
ProgressivePromise<V> 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 Promise<V>
  - addListener
```
ProgressivePromise<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.
    
    Specified by:
    
    addListener in interface ProgressiveFuture<V>
    
    Specified by:
    
    addListener in interface Promise<V>
  - addListeners
```
ProgressivePromise<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.
    
    Specified by:
    
    addListeners in interface ProgressiveFuture<V>
    
    Specified by:
    
    addListeners in interface Promise<V>
  - removeListener
```
ProgressivePromise<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.
    
    Specified by:
    
    removeListener in interface ProgressiveFuture<V>
    
    Specified by:
    
    removeListener in interface Promise<V>
  - removeListeners
```
ProgressivePromise<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.
    
    Specified by:
    
    removeListeners in interface ProgressiveFuture<V>
    
    Specified by:
    
    removeListeners in interface Promise<V>
  - await
```
ProgressivePromise<V> await()
                     throws java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed.
    
    Specified by:
    
    await in interface ProgressiveFuture<V>
    
    Specified by:
    
    await in interface Promise<V>
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
ProgressivePromise<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.
    
    Specified by:
    
    awaitUninterruptibly in interface ProgressiveFuture<V>
    
    Specified by:
    
    awaitUninterruptibly in interface Promise<V>
  - sync
```
ProgressivePromise<V> 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 ProgressiveFuture<V>
    
    Specified by:
    
    sync in interface Promise<V>
    
    Throws:
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
ProgressivePromise<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.
    
    Specified by:
    
    syncUninterruptibly in interface ProgressiveFuture<V>
    
    Specified by:
    
    syncUninterruptibly in interface Promise<V>

Interface ProgressivePromise<V>

Method Summary

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

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

Methods inherited from interface java.util.concurrent.Future

Method Detail

setProgress

tryProgress

setSuccess

setFailure

addListener

addListeners

removeListener

removeListeners

await

awaitUninterruptibly

sync

syncUninterruptibly