DefaultChannelPromise (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.util.concurrent.AbstractFuture<V>
- - io.netty.util.concurrent.DefaultPromise<java.lang.Void>
  - - io.netty.channel.DefaultChannelPromise

所有已实现的接口:

ChannelFuture, ChannelPromise, Promise<java.lang.Void>, java.util.concurrent.Future<java.lang.Void>
```
public class DefaultChannelPromise
extends DefaultPromise<java.lang.Void>
implements ChannelPromise
```
The default ChannelPromise implementation. It is recommended to use ChannelOutboundInvoker.newPromise() to create a new ChannelPromise rather than calling the constructor explicitly.

构造器概要

构造器
构造器和说明
`DefaultChannelPromise(Channel channel)` Creates a new instance.
`DefaultChannelPromise(Channel channel, EventExecutor executor)` Creates a new instance.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`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.
`protected void`	`checkDeadLock()`
`protected EventExecutor`	`executor()` Get the executor used to notify listeners when this promise is complete.
`long`	`flushCheckpoint()`
`void`	`flushCheckpoint(long checkpoint)`
`boolean`	`isVoid()` Returns `true` if this `ChannelFuture` is a void future and so not allow to call any of the following methods: `ChannelFuture.addListener(GenericFutureListener)` `ChannelFuture.addListeners(GenericFutureListener[])` `ChannelFuture.await()` `Future.await(long, TimeUnit)` ()} `Future.await(long)` ()} `ChannelFuture.awaitUninterruptibly()` `ChannelFuture.sync()` `ChannelFuture.syncUninterruptibly()`
`ChannelPromise`	`promise()`
`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()`
`ChannelPromise`	`unvoid()` Returns a new `ChannelPromise` if `ChannelFuture.isVoid()` returns `true` otherwise itself.

从类继承的方法 io.netty.util.concurrent.DefaultPromise
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- 构造器详细资料
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel)
```
    Creates a new instance.
    
    参数:
    
    channel - the Channel associated with this future
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel,
                             EventExecutor executor)
```
    Creates a new instance.
    
    参数:
    
    channel - the Channel associated with this future
- 方法详细资料
  - executor
```
protected EventExecutor executor()
```
    从类复制的说明: DefaultPromise
    
    Get the executor used to notify listeners when this promise is complete.
    It is assumed this executor will protect against StackOverflowError exceptions. The executor may be used to avoid StackOverflowError by executing a Runnable if the stack depth exceeds a threshold.
    
    覆盖:
    
    executor 在类中 DefaultPromise<java.lang.Void>
    
    返回:
    
    The executor used to notify listeners when this promise is complete.
  - channel
```
public Channel channel()
```
    从接口复制的说明: ChannelFuture
    
    Returns a channel where the I/O operation associated with this future takes place.
    
    指定者:
    
    channel 在接口中 ChannelFuture
    
    指定者:
    
    channel 在接口中 ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess()
```
    指定者:
    
    setSuccess 在接口中 ChannelPromise
  - setSuccess
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    setSuccess 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    setSuccess 在类中 DefaultPromise<java.lang.Void>
  - trySuccess
```
public boolean trySuccess()
```
    指定者:
    
    trySuccess 在接口中 ChannelPromise
  - setFailure
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    setFailure 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    setFailure 在类中 DefaultPromise<java.lang.Void>
  - addListener
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    addListener 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    addListener 在类中 DefaultPromise<java.lang.Void>
  - addListeners
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    addListeners 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    addListeners 在类中 DefaultPromise<java.lang.Void>
  - removeListener
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    removeListener 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    removeListener 在类中 DefaultPromise<java.lang.Void>
  - removeListeners
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    removeListeners 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    removeListeners 在类中 DefaultPromise<java.lang.Void>
  - sync
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    sync 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    sync 在类中 DefaultPromise<java.lang.Void>
    
    抛出:
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public 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 在接口中 ChannelPromise
    
    指定者:
    
    syncUninterruptibly 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    syncUninterruptibly 在类中 DefaultPromise<java.lang.Void>
  - await
```
public ChannelPromise await()
                     throws java.lang.InterruptedException
```
    从接口复制的说明: Future
    
    Waits for this future to be completed.
    
    指定者:
    
    await 在接口中 ChannelFuture
    
    指定者:
    
    await 在接口中 ChannelPromise
    
    指定者:
    
    await 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    await 在类中 DefaultPromise<java.lang.Void>
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public ChannelPromise awaitUninterruptibly()
```
    从接口复制的说明: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
    
    指定者:
    
    awaitUninterruptibly 在接口中 ChannelFuture
    
    指定者:
    
    awaitUninterruptibly 在接口中 ChannelPromise
    
    指定者:
    
    awaitUninterruptibly 在接口中 Promise<java.lang.Void>
    
    覆盖:
    
    awaitUninterruptibly 在类中 DefaultPromise<java.lang.Void>
  - flushCheckpoint
```
public long flushCheckpoint()
```
  - flushCheckpoint
```
public void flushCheckpoint(long checkpoint)
```
  - promise
```
public ChannelPromise promise()
```
  - checkDeadLock
```
protected void checkDeadLock()
```
    覆盖:
    
    checkDeadLock 在类中 DefaultPromise<java.lang.Void>
  - unvoid
```
public ChannelPromise unvoid()
```
    从接口复制的说明: ChannelPromise
    
    Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.
    
    指定者:
    
    unvoid 在接口中 ChannelPromise
  - isVoid
```
public boolean isVoid()
```
    从接口复制的说明: ChannelFuture
    Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods:
    指定者:
    
    isVoid 在接口中 ChannelFuture

类 DefaultChannelPromise

构造器概要

方法概要

从类继承的方法 io.netty.util.concurrent.DefaultPromise

从类继承的方法 java.lang.Object

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

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

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

构造器详细资料

DefaultChannelPromise

DefaultChannelPromise

方法详细资料

executor

channel

setSuccess

setSuccess

trySuccess

setFailure

addListener

addListeners

removeListener

removeListeners

sync

syncUninterruptibly

await

awaitUninterruptibly

flushCheckpoint

flushCheckpoint

promise

checkDeadLock

unvoid

isVoid