io.netty.channel

接口 ChannelProgressivePromise

所有超级接口:

ChannelFuture, ChannelProgressiveFuture, ChannelPromise, java.util.concurrent.Future<java.lang.Void>, ProgressiveFuture<java.lang.Void>, ProgressivePromise<java.lang.Void>, Promise<java.lang.Void>

所有已知实现类:

DefaultChannelProgressivePromise

public interface ChannelProgressivePromise
extends ProgressivePromise<java.lang.Void>, ChannelProgressiveFuture, ChannelPromise

Special ChannelPromise which will be notified once the associated bytes is transferring.

方法概要

限定符和类型	方法和说明
ChannelProgressivePromise	addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Adds the specified listener to this future.
ChannelProgressivePromise	addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Adds the specified listeners to this future.
ChannelProgressivePromise	await() Waits for this future to be completed.
ChannelProgressivePromise	awaitUninterruptibly() Waits for this future to be completed without interruption.
ChannelProgressivePromise	removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Removes the first occurrence of the specified listener from this future.
ChannelProgressivePromise	removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Removes the first occurrence for each of the listeners from this future.
ChannelProgressivePromise	setFailure(java.lang.Throwable cause) Marks this future as a failure and notifies all listeners.
ChannelProgressivePromise	setProgress(long progress, long total) Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.
ChannelProgressivePromise	setSuccess()
ChannelProgressivePromise	setSuccess(java.lang.Void result) Marks this future as a success and notifies all listeners.
ChannelProgressivePromise	sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelProgressivePromise	syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelProgressivePromise	unvoid() Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.

从接口继承的方法 io.netty.util.concurrent.ProgressivePromise

tryProgress

从接口继承的方法 io.netty.channel.ChannelPromise

channel, trySuccess

从接口继承的方法 io.netty.channel.ChannelFuture

isVoid

从接口继承的方法 io.netty.util.concurrent.Promise

setUncancellable, tryFailure, trySuccess

从接口继承的方法 io.netty.util.concurrent.Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

从接口继承的方法 java.util.concurrent.Future

get, get, isCancelled, isDone

方法详细资料

addListener

ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

从接口复制的说明: 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.

指定者:

addListener 在接口中 ChannelFuture

指定者:

addListener 在接口中 ChannelProgressiveFuture

指定者:

addListener 在接口中 ChannelPromise

指定者:

addListener 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

addListener 在接口中 ProgressivePromise<java.lang.Void>

指定者:

addListener 在接口中 Promise<java.lang.Void>

addListeners

ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

从接口复制的说明: 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.

指定者:

addListeners 在接口中 ChannelFuture

指定者:

addListeners 在接口中 ChannelProgressiveFuture

指定者:

addListeners 在接口中 ChannelPromise

指定者:

addListeners 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

addListeners 在接口中 ProgressivePromise<java.lang.Void>

指定者:

addListeners 在接口中 Promise<java.lang.Void>

removeListener

ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

从接口复制的说明: 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.

指定者:

removeListener 在接口中 ChannelFuture

指定者:

removeListener 在接口中 ChannelProgressiveFuture

指定者:

removeListener 在接口中 ChannelPromise

指定者:

removeListener 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

removeListener 在接口中 ProgressivePromise<java.lang.Void>

指定者:

removeListener 在接口中 Promise<java.lang.Void>

removeListeners

ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

从接口复制的说明: 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.

指定者:

removeListeners 在接口中 ChannelFuture

指定者:

removeListeners 在接口中 ChannelProgressiveFuture

指定者:

removeListeners 在接口中 ChannelPromise

指定者:

removeListeners 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

removeListeners 在接口中 ProgressivePromise<java.lang.Void>

指定者:

removeListeners 在接口中 Promise<java.lang.Void>

sync

ChannelProgressivePromise sync()
                        throws java.lang.InterruptedException

从接口复制的说明: Future

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

指定者:

sync 在接口中 ChannelFuture

指定者:

sync 在接口中 ChannelProgressiveFuture

指定者:

sync 在接口中 ChannelPromise

指定者:

sync 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

sync 在接口中 ProgressivePromise<java.lang.Void>

指定者:

sync 在接口中 Promise<java.lang.Void>

抛出:

java.lang.InterruptedException

syncUninterruptibly

ChannelProgressivePromise syncUninterruptibly()

从接口复制的说明: Future

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

指定者:

syncUninterruptibly 在接口中 ChannelFuture

指定者:

syncUninterruptibly 在接口中 ChannelProgressiveFuture

指定者:

syncUninterruptibly 在接口中 ChannelPromise

指定者:

syncUninterruptibly 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

syncUninterruptibly 在接口中 ProgressivePromise<java.lang.Void>

指定者:

syncUninterruptibly 在接口中 Promise<java.lang.Void>

await

ChannelProgressivePromise await()
                         throws java.lang.InterruptedException

从接口复制的说明: Future

Waits for this future to be completed.

指定者:

await 在接口中 ChannelFuture

指定者:

await 在接口中 ChannelProgressiveFuture

指定者:

await 在接口中 ChannelPromise

指定者:

await 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

await 在接口中 ProgressivePromise<java.lang.Void>

指定者:

await 在接口中 Promise<java.lang.Void>

抛出:

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

awaitUninterruptibly

ChannelProgressivePromise awaitUninterruptibly()

从接口复制的说明: Future

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

指定者:

awaitUninterruptibly 在接口中 ChannelFuture

指定者:

awaitUninterruptibly 在接口中 ChannelProgressiveFuture

指定者:

awaitUninterruptibly 在接口中 ChannelPromise

指定者:

awaitUninterruptibly 在接口中 ProgressiveFuture<java.lang.Void>

指定者:

awaitUninterruptibly 在接口中 ProgressivePromise<java.lang.Void>

指定者:

awaitUninterruptibly 在接口中 Promise<java.lang.Void>

setSuccess

ChannelProgressivePromise setSuccess(java.lang.Void result)

从接口复制的说明: Promise

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

指定者:

setSuccess 在接口中 ChannelPromise

指定者:

setSuccess 在接口中 ProgressivePromise<java.lang.Void>

指定者:

setSuccess 在接口中 Promise<java.lang.Void>

setSuccess

ChannelProgressivePromise setSuccess()

指定者:

setSuccess 在接口中 ChannelPromise

setFailure

ChannelProgressivePromise setFailure(java.lang.Throwable cause)

从接口复制的说明: Promise

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

指定者:

setFailure 在接口中 ChannelPromise

指定者:

setFailure 在接口中 ProgressivePromise<java.lang.Void>

指定者:

setFailure 在接口中 Promise<java.lang.Void>

setProgress

ChannelProgressivePromise setProgress(long progress,
                                      long total)

从接口复制的说明: ProgressivePromise

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

指定者:

setProgress 在接口中 ProgressivePromise<java.lang.Void>

unvoid

ChannelProgressivePromise unvoid()

从接口复制的说明: ChannelPromise

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

指定者:

unvoid 在接口中 ChannelPromise