io.netty.channel

接口 ChannelPromise

所有超级接口:

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

所有已知子接口:

ChannelProgressivePromise

所有已知实现类:

DefaultChannelProgressivePromise, DefaultChannelPromise

public interface ChannelPromise
extends ChannelFuture, Promise<java.lang.Void>

Special ChannelFuture which is writable.

方法概要

方法

限定符和类型	方法和说明
ChannelPromise	addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Adds the specified listener to this future.
ChannelPromise	addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Adds the specified listeners to this future.
ChannelPromise	await() Waits for this future to be completed.
ChannelPromise	awaitUninterruptibly() Waits for this future to be completed without interruption.
Channel	channel() Returns a channel where the I/O operation associated with this future takes place.
ChannelPromise	removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Removes the first occurrence of the specified listener from this future.
ChannelPromise	removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Removes the first occurrence for each of the listeners from this future.
ChannelPromise	setFailure(java.lang.Throwable cause) Marks this future as a failure and notifies all listeners.
ChannelPromise	setSuccess()
ChannelPromise	setSuccess(java.lang.Void result) Marks this future as a success and notifies all listeners.
ChannelPromise	sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelPromise	syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
boolean	trySuccess()

从接口继承的方法 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

方法详细资料

channel

Channel channel()

从接口复制的说明: ChannelFuture

Returns a channel where the I/O operation associated with this future takes place.

指定者:

channel 在接口中 ChannelFuture

setSuccess

ChannelPromise 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 在接口中 Promise<java.lang.Void>

setSuccess

ChannelPromise setSuccess()

trySuccess

boolean trySuccess()

setFailure

ChannelPromise 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 在接口中 Promise<java.lang.Void>

addListener

ChannelPromise 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 在接口中 Promise<java.lang.Void>

addListeners

ChannelPromise 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 在接口中 Promise<java.lang.Void>

removeListener

ChannelPromise 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 在接口中 Promise<java.lang.Void>

removeListeners

ChannelPromise 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 在接口中 Promise<java.lang.Void>

sync

ChannelPromise 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 在接口中 Promise<java.lang.Void>

抛出:

java.lang.InterruptedException

syncUninterruptibly

ChannelPromise syncUninterruptibly()

从接口复制的说明: Future

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

指定者:

syncUninterruptibly 在接口中 ChannelFuture

指定者:

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

await

ChannelPromise await()
                     throws java.lang.InterruptedException

从接口复制的说明: Future

Waits for this future to be completed.

指定者:

await 在接口中 ChannelFuture

指定者:

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

抛出:

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

awaitUninterruptibly

ChannelPromise awaitUninterruptibly()

从接口复制的说明: Future

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

指定者:

awaitUninterruptibly 在接口中 ChannelFuture

指定者:

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