io.netty.channel

Interface ChannelProgressiveFuture

All Superinterfaces:

ChannelFuture, java.util.concurrent.Future<java.lang.Void>, ProgressiveFuture<java.lang.Void>

All Known Subinterfaces:

ChannelProgressivePromise

All Known Implementing Classes:

DefaultChannelProgressivePromise

public interface ChannelProgressiveFuture
extends ChannelFuture, ProgressiveFuture<java.lang.Void>

An special ChannelFuture which is used to indicate the FileRegion transfer progress

Method Summary

Modifier and Type	Method and Description
ChannelProgressiveFuture	addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Adds the specified listener to this future.
ChannelProgressiveFuture	addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Adds the specified listeners to this future.
ChannelProgressiveFuture	await() Waits for this future to be completed.
ChannelProgressiveFuture	awaitUninterruptibly() Waits for this future to be completed without interruption.
ChannelProgressiveFuture	removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Removes the first occurrence of the specified listener from this future.
ChannelProgressiveFuture	removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Removes the first occurrence for each of the listeners from this future.
ChannelProgressiveFuture	sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelProgressiveFuture	syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from interface io.netty.channel.ChannelFuture

channel

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

addListener

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

addListeners

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

removeListener

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

removeListeners

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

sync

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

Throws:

java.lang.InterruptedException

syncUninterruptibly

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

await

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>

Throws:

java.lang.InterruptedException - if the current thread was interrupted

awaitUninterruptibly

ChannelProgressiveFuture 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 ProgressiveFuture<java.lang.Void>