Top Description Methods
io.netty.channel

public Interface ChannelProgressivePromise

extends ProgressivePromise<Void>, ChannelProgressiveFuture, ChannelPromise
Known Direct Implementers
io.netty.channel.DefaultChannelProgressivePromise
Imports
io.netty.util.concurrent.Future, .GenericFutureListener, .ProgressivePromise
Special ChannelPromise which will be notified once the associated bytes is transferring.

Method Summary

Modifier and TypeMethod and Description
public ChannelProgressivePromise
addListener(GenericFutureListener<? extends Future<? super Void>> listener)

Redeclares io.netty.util.concurrent.ProgressivePromise.addListener, io.netty.channel.ChannelProgressiveFuture.addListener, io.netty.channel.ChannelPromise.addListener.

Adds the specified listener to this future.
public ChannelProgressivePromise
addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Redeclares io.netty.util.concurrent.ProgressivePromise.addListeners, io.netty.channel.ChannelProgressiveFuture.addListeners, io.netty.channel.ChannelPromise.addListeners.

Adds the specified listeners to this future.
public ChannelProgressivePromise
await()

Redeclares io.netty.util.concurrent.ProgressivePromise.await, io.netty.channel.ChannelProgressiveFuture.await, io.netty.channel.ChannelPromise.await.

Waits for this future to be completed.
public ChannelProgressivePromise
awaitUninterruptibly()

Redeclares io.netty.util.concurrent.ProgressivePromise.awaitUninterruptibly, io.netty.channel.ChannelProgressiveFuture.awaitUninterruptibly, io.netty.channel.ChannelPromise.awaitUninterruptibly.

Waits for this future to be completed without interruption.
public ChannelProgressivePromise
removeListener(GenericFutureListener<? extends Future<? super Void>> listener)

Redeclares io.netty.util.concurrent.ProgressivePromise.removeListener, io.netty.channel.ChannelProgressiveFuture.removeListener, io.netty.channel.ChannelPromise.removeListener.

Removes the first occurrence of the specified listener from this future.
public ChannelProgressivePromise
removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Redeclares io.netty.util.concurrent.ProgressivePromise.removeListeners, io.netty.channel.ChannelProgressiveFuture.removeListeners, io.netty.channel.ChannelPromise.removeListeners.

Removes the first occurrence for each of the listeners from this future.
public ChannelProgressivePromise
setFailure(Throwable cause)

Redeclares io.netty.util.concurrent.ProgressivePromise.setFailure, io.netty.channel.ChannelPromise.setFailure.

Marks this future as a failure and notifies all listeners.
public ChannelProgressivePromise
setProgress(long progress, long total)

Redeclares io.netty.util.concurrent.ProgressivePromise.setProgress.

Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.
public ChannelProgressivePromise
setSuccess(Void result)

Redeclares io.netty.util.concurrent.ProgressivePromise.setSuccess, io.netty.channel.ChannelPromise.setSuccess.

Marks this future as a success and notifies all listeners.
public ChannelProgressivePromise
setSuccess()

Redeclares io.netty.channel.ChannelPromise.setSuccess.

public ChannelProgressivePromise
sync()

Redeclares io.netty.util.concurrent.ProgressivePromise.sync, io.netty.channel.ChannelProgressiveFuture.sync, io.netty.channel.ChannelPromise.sync.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
public ChannelProgressivePromise
syncUninterruptibly()

Redeclares io.netty.util.concurrent.ProgressivePromise.syncUninterruptibly, io.netty.channel.ChannelProgressiveFuture.syncUninterruptibly, io.netty.channel.ChannelPromise.syncUninterruptibly.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
public ChannelProgressivePromise
unvoid()

Redeclares io.netty.channel.ChannelPromise.unvoid.

Returns a new ChannelPromise if isVoid() returns true otherwise itself.
Inherited from io.netty.channel.ChannelPromise:
channeltrySuccess
Inherited from io.netty.util.concurrent.ProgressivePromise:
tryProgress

Method Detail

addListenerback to summary
public ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super Void>> listener)

Redeclares io.netty.util.concurrent.ProgressivePromise.addListener, io.netty.channel.ChannelProgressiveFuture.addListener, io.netty.channel.ChannelPromise.addListener.

Doc from io.netty.util.concurrent.Future.addListener.

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.

Annotations
@Override
addListenersback to summary
public ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Redeclares io.netty.util.concurrent.ProgressivePromise.addListeners, io.netty.channel.ChannelProgressiveFuture.addListeners, io.netty.channel.ChannelPromise.addListeners.

Doc from io.netty.util.concurrent.Future.addListeners.

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.

Annotations
@Override
awaitback to summary
public ChannelProgressivePromise await() throws InterruptedException

Redeclares io.netty.util.concurrent.ProgressivePromise.await, io.netty.channel.ChannelProgressiveFuture.await, io.netty.channel.ChannelPromise.await.

Doc from io.netty.util.concurrent.Future.await.

Waits for this future to be completed.

Annotations
@Override
Exceptions
InterruptedException:
if the current thread was interrupted
awaitUninterruptiblyback to summary
public ChannelProgressivePromise awaitUninterruptibly()

Redeclares io.netty.util.concurrent.ProgressivePromise.awaitUninterruptibly, io.netty.channel.ChannelProgressiveFuture.awaitUninterruptibly, io.netty.channel.ChannelPromise.awaitUninterruptibly.

Doc from io.netty.util.concurrent.Future.awaitUninterruptibly.

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Annotations
@Override
removeListenerback to summary
public ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener)

Redeclares io.netty.util.concurrent.ProgressivePromise.removeListener, io.netty.channel.ChannelProgressiveFuture.removeListener, io.netty.channel.ChannelPromise.removeListener.

Doc from io.netty.util.concurrent.Future.removeListener.

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.

Annotations
@Override
removeListenersback to summary
public ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Redeclares io.netty.util.concurrent.ProgressivePromise.removeListeners, io.netty.channel.ChannelProgressiveFuture.removeListeners, io.netty.channel.ChannelPromise.removeListeners.

Doc from io.netty.util.concurrent.Future.removeListeners.

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.

Annotations
@Override
setFailureback to summary
public ChannelProgressivePromise setFailure(Throwable cause)

Redeclares io.netty.util.concurrent.ProgressivePromise.setFailure, io.netty.channel.ChannelPromise.setFailure.

Doc from io.netty.util.concurrent.Promise.setFailure.

Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Annotations
@Override
setProgressback to summary
public ChannelProgressivePromise setProgress(long progress, long total)

Redeclares io.netty.util.concurrent.ProgressivePromise.setProgress.

Doc from io.netty.util.concurrent.ProgressivePromise.setProgress.

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

Annotations
@Override
setSuccessback to summary
public ChannelProgressivePromise setSuccess(Void result)

Redeclares io.netty.util.concurrent.ProgressivePromise.setSuccess, io.netty.channel.ChannelPromise.setSuccess.

Doc from io.netty.util.concurrent.Promise.setSuccess.

Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Annotations
@Override
setSuccessback to summary
public ChannelProgressivePromise setSuccess()

Redeclares io.netty.channel.ChannelPromise.setSuccess.

Annotations
@Override
syncback to summary
public ChannelProgressivePromise sync() throws InterruptedException

Redeclares io.netty.util.concurrent.ProgressivePromise.sync, io.netty.channel.ChannelProgressiveFuture.sync, io.netty.channel.ChannelPromise.sync.

Doc from io.netty.util.concurrent.Future.sync.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Annotations
@Override
syncUninterruptiblyback to summary
public ChannelProgressivePromise syncUninterruptibly()

Redeclares io.netty.util.concurrent.ProgressivePromise.syncUninterruptibly, io.netty.channel.ChannelProgressiveFuture.syncUninterruptibly, io.netty.channel.ChannelPromise.syncUninterruptibly.

Doc from io.netty.util.concurrent.Future.syncUninterruptibly.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Annotations
@Override
unvoidback to summary
public ChannelProgressivePromise unvoid()

Redeclares io.netty.channel.ChannelPromise.unvoid.

Doc from io.netty.channel.ChannelPromise.unvoid.

Returns a new ChannelPromise if isVoid() returns true otherwise itself.

Annotations
@Override