DefaultChannelPromise (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelFuture ， ChannelPromise ， Promise <java.lang.Void的>，java.util.concurrent.Future <java.lang.Void的>
```
public class DefaultChannelPromise
extends DefaultPromise<java.lang.Void>
implements ChannelPromise
```
默认的ChannelPromise实现。建议使用ChannelOutboundInvoker.newPromise()创建新的ChannelPromise，而不是显式调用构造函数。

构造方法摘要

构造方法
Constructor and Description
`DefaultChannelPromise(Channel channel)` 创建一个新的实例。
`DefaultChannelPromise(Channel channel, EventExecutor executor)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`ChannelPromise`	`addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` 将指定的侦听器添加到此将来。
`ChannelPromise`	`addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 将指定的侦听器添加到此将来。
`ChannelPromise`	`await()` 等待这个未来的完成。
`ChannelPromise`	`awaitUninterruptibly()` 等待这个未来不中断地完成。
`Channel`	`channel()` 返回与此未来相关的I / O操作发生的通道。
`protected void`	`checkDeadLock()`
`protected EventExecutor`	`executor()` 当这个承诺完成时，让执行者用来通知监听者。
`long`	`flushCheckpoint()`
`void`	`flushCheckpoint(long checkpoint)`
`boolean`	`isVoid()` 返回`true`如果这`ChannelFuture`是一个无效的未来，所以不允许调用任何下列方法： `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)` 从此将来删除指定侦听器的第一个匹配项。
`ChannelPromise`	`removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 为将来的每个听众删除第一个匹配项。
`ChannelPromise`	`setFailure(java.lang.Throwable cause)` 将这个未来标志为失败并通知所有听众。
`ChannelPromise`	`setSuccess()`
`ChannelPromise`	`setSuccess(java.lang.Void result)` 将这个未来标志为成功并通知所有听众。
`ChannelPromise`	`sync()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`ChannelPromise`	`syncUninterruptibly()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`boolean`	`trySuccess()`
`ChannelPromise`	`unvoid()` 如果`ChannelFuture.isVoid()`本身返回`true`则返回新的`ChannelPromise` 。

Methods inherited from class io.netty.util.concurrent.DefaultPromise
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess

Methods inherited from class io.netty.util.concurrent.AbstractFuture
get, get

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.util.concurrent.Promise
setUncancellable, tryFailure, trySuccess

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

- 构造方法详细信息
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel)
```
    创建一个新的实例。
    
    参数
    
    channel - 与此未来相关的Channel
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel,
                             EventExecutor executor)
```
    创建一个新的实例。
    
    参数
    
    channel - 与此未来相关的Channel
- 方法详细信息
  - executor
```
protected EventExecutor executor()
```
    从类复制的描述： DefaultPromise
    
    当这个承诺完成时，让执行者用来通知监听者。
    假定该执行者将防止StackOverflowError例外。如果堆栈深度超过阈值，执行程序可以通过执行Runnable来避免StackOverflowError 。
    
    重写：
    
    executor在课程 DefaultPromise<java.lang.Void>
    
    结果
    
    执行者用于在完成此承诺时通知监听者。
  - channel
```
public Channel channel()
```
    从接口复制的描述： ChannelFuture
    
    返回与此未来相关的I / O操作发生的通道。
    
    Specified by:
    
    channel接口 ChannelFuture
    
    Specified by:
    
    channel接口 ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess()
```
    Specified by:
    
    setSuccess在界面 ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess(java.lang.Void result)
```
    从接口Promise复制的描述
    
    将这个未来标志为成功并通知所有听众。如果它已经成功或失败，它会抛出IllegalStateException 。
    
    Specified by:
    
    setSuccess在界面 ChannelPromise
    
    Specified by:
    
    setSuccess在界面 Promise<java.lang.Void>
    
    重写：
    
    setSuccess在课堂上 DefaultPromise<java.lang.Void>
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess接口 ChannelPromise
  - setFailure
```
public ChannelPromise setFailure(java.lang.Throwable cause)
```
    从接口复制的描述： Promise
    
    将这个未来标志为失败并通知所有听众。如果它已经成功或失败，它会抛出IllegalStateException 。
    
    Specified by:
    
    setFailure接口 ChannelPromise
    
    Specified by:
    
    setFailure接口 Promise<java.lang.Void>
    
    重写：
    
    setFailure DefaultPromise<java.lang.Void>
  - addListener
```
public ChannelPromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    从界面复制而来的描述： Future
    
    将指定的侦听器添加到此将来。当这个未来完成时，通知指定的监听器。如果这个未来已经完成，立即通知指定的监听器。
    
    Specified by:
    
    addListener在界面 ChannelFuture
    
    Specified by:
    
    addListener接口 ChannelPromise
    
    Specified by:
    
    addListener接口 Promise<java.lang.Void>
    
    重写：
    
    addListener在课堂上 DefaultPromise<java.lang.Void>
  - addListeners
```
public ChannelPromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    从接口复制的描述： Future
    
    将指定的侦听器添加到此将来。这个未来完成时，通知指定的监听者。如果这个未来已经完成，则立即通知指定的监听者。
    
    Specified by:
    
    addListeners接口 ChannelFuture
    
    Specified by:
    
    addListeners接口 ChannelPromise
    
    Specified by:
    
    addListeners在界面 Promise<java.lang.Void>
    
    重写：
    
    addListeners在课堂上 DefaultPromise<java.lang.Void>
  - removeListener
```
public ChannelPromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    从接口Future复制的描述
    
    从此将来删除指定侦听器的第一个匹配项。未来完成时，指定的监听器不再通知。如果指定的侦听器未与此将来关联，则此方法不执行任何操作并以静默方式返回。
    
    Specified by:
    
    removeListener在界面 ChannelFuture
    
    Specified by:
    
    removeListener ，界面 ChannelPromise
    
    Specified by:
    
    removeListener接口 Promise<java.lang.Void>
    
    重写：
    
    removeListener在课堂上 DefaultPromise<java.lang.Void>
  - removeListeners
```
public ChannelPromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    从界面复制的描述： Future
    
    为将来的每个听众删除第一个匹配项。未来完成时，指定的监听器不再通知。如果指定的侦听器未与此将来关联，则此方法不执行任何操作并以静默方式返回。
    
    Specified by:
    
    removeListeners在界面 ChannelFuture
    
    Specified by:
    
    removeListeners接口 ChannelPromise
    
    Specified by:
    
    removeListeners在界面 Promise<java.lang.Void>
    
    重写：
    
    removeListeners在课堂上 DefaultPromise<java.lang.Void>
  - sync
```
public ChannelPromise sync()
                    throws java.lang.InterruptedException
```
    从接口Future复制的描述
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    sync接口 ChannelFuture
    
    Specified by:
    
    sync接口 ChannelPromise
    
    Specified by:
    
    sync在界面 Promise<java.lang.Void>
    
    重写：
    
    sync DefaultPromise<java.lang.Void>
    
    异常
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public ChannelPromise syncUninterruptibly()
```
    从界面复制的描述： Future
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    syncUninterruptibly ，界面 ChannelFuture
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelPromise
    
    Specified by:
    
    syncUninterruptibly接口 Promise<java.lang.Void>
    
    重写：
    
    syncUninterruptibly ，上课 DefaultPromise<java.lang.Void>
  - await
```
public ChannelPromise await()
                     throws java.lang.InterruptedException
```
    从界面复制的描述： Future
    
    等待这个未来的完成。
    
    Specified by:
    
    await在界面 ChannelFuture
    
    Specified by:
    
    await在界面 ChannelPromise
    
    Specified by:
    
    await在界面 Promise<java.lang.Void>
    
    重写：
    
    await在课堂上 DefaultPromise<java.lang.Void>
    
    异常
    
    java.lang.InterruptedException - 如果当前线程中断
  - awaitUninterruptibly
```
public ChannelPromise awaitUninterruptibly()
```
    从接口复制的描述： Future
    
    等待这个未来不中断地完成。此方法捕获InterruptedException并以静默方式丢弃它。
    
    Specified by:
    
    awaitUninterruptibly接口 ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly ，界面 ChannelPromise
    
    Specified by:
    
    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复制的描述
    
    如果ChannelFuture.isVoid()本身返回true则返回新的ChannelPromise 。
    
    Specified by:
    
    unvoid接口 ChannelPromise
  - isVoid
```
public boolean isVoid()
```
    从界面复制的描述： ChannelFuture
    如果此ChannelFuture是无效未来，并且不允许调用以下任何方法，则返回true ：
    Specified by:
    
    isVoid ，界面 ChannelFuture

Class DefaultChannelPromise

构造方法摘要

方法摘要

Methods inherited from class io.netty.util.concurrent.DefaultPromise

Methods inherited from class io.netty.util.concurrent.AbstractFuture

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.concurrent.Promise

Methods inherited from interface io.netty.util.concurrent.Future

Methods inherited from interface 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