io.netty.util.concurrent

Class DefaultProgressivePromise<V>

java.lang.Object

io.netty.util.concurrent.AbstractFuture<V>

io.netty.util.concurrent.DefaultPromise<V>

io.netty.util.concurrent.DefaultProgressivePromise<V>

All Implemented Interfaces:

ProgressiveFuture<V>, ProgressivePromise<V>, Promise<V>, Future<V>

Direct Known Subclasses:

DefaultChannelProgressivePromise

public class DefaultProgressivePromise<V>
extends DefaultPromise<V>
implements ProgressivePromise<V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultProgressivePromise()
	DefaultProgressivePromise(EventExecutor executor) Creates a new instance.

Method Summary

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(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 class io.netty.util.concurrent.DefaultPromise

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, checkDeadLock, executor, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess

Methods inherited from class io.netty.util.concurrent.AbstractFuture

get, get

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DefaultProgressivePromise

public DefaultProgressivePromise(EventExecutor executor)

Creates a new instance. It is preferable to use EventExecutor.newProgressivePromise() to create a new progressive promise

Parameters:

executor - the EventExecutor which is used to notify the promise when it progresses or it is complete

DefaultProgressivePromise

protected DefaultProgressivePromise()

Method Detail

setProgress

public ProgressivePromise<V> setProgress(long progress,
                                         long total)

Description copied from interface: ProgressivePromise

Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.

Specified by:

setProgress in interface ProgressivePromise<V>

tryProgress

public boolean tryProgress(long progress,
                           long total)

Description copied from interface: ProgressivePromise

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.

Specified by:

tryProgress in interface ProgressivePromise<V>

addListener

public 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 ProgressivePromise<V>

Specified by:

addListener in interface Promise<V>

Overrides:

addListener in class DefaultPromise<V>

addListeners

public 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 ProgressivePromise<V>

Specified by:

addListeners in interface Promise<V>

Overrides:

addListeners in class DefaultPromise<V>

removeListener

public 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 ProgressivePromise<V>

Specified by:

removeListener in interface Promise<V>

Overrides:

removeListener in class DefaultPromise<V>

removeListeners

public 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 ProgressivePromise<V>

Specified by:

removeListeners in interface Promise<V>

Overrides:

removeListeners in class DefaultPromise<V>

sync

public ProgressivePromise<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.

Specified by:

sync in interface ProgressiveFuture<V>

Specified by:

sync in interface ProgressivePromise<V>

Specified by:

sync in interface Promise<V>

Overrides:

sync in class DefaultPromise<V>

Throws:

InterruptedException

syncUninterruptibly

public 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 ProgressivePromise<V>

Specified by:

syncUninterruptibly in interface Promise<V>

Overrides:

syncUninterruptibly in class DefaultPromise<V>

await

public ProgressivePromise<V> await()
                            throws 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 ProgressivePromise<V>

Specified by:

await in interface Promise<V>

Overrides:

await in class DefaultPromise<V>

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public 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 ProgressivePromise<V>

Specified by:

awaitUninterruptibly in interface Promise<V>

Overrides:

awaitUninterruptibly in class DefaultPromise<V>

setSuccess

public 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 ProgressivePromise<V>

Specified by:

setSuccess in interface Promise<V>

Overrides:

setSuccess in class DefaultPromise<V>

setFailure

public ProgressivePromise<V> setFailure(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 ProgressivePromise<V>

Specified by:

setFailure in interface Promise<V>

Overrides:

setFailure in class DefaultPromise<V>