DefaultChannelProgressivePromise (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelFuture ， ChannelProgressiveFuture ， ChannelProgressivePromise ， ChannelPromise ， ProgressiveFuture <java.lang.Void的>， ProgressivePromise <java.lang.Void的>， Promise <java.lang.Void的>，java.util.concurrent.Future <java.lang.Void的>
```
public class DefaultChannelProgressivePromise
extends DefaultProgressivePromise<java.lang.Void>
implements ChannelProgressivePromise
```
默认的ChannelProgressivePromise实现。建议使用ChannelOutboundInvoker.newProgressivePromise()来创建新的ChannelProgressivePromise，而不是显式调用构造函数。

构造方法摘要

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

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`ChannelProgressivePromise`	`addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` 将指定的侦听器添加到此将来。
`ChannelProgressivePromise`	`addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 将指定的侦听器添加到此将来。
`ChannelProgressivePromise`	`await()` 等待这个未来的完成。
`ChannelProgressivePromise`	`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()`
`ChannelProgressivePromise`	`promise()`
`ChannelProgressivePromise`	`removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` 从此将来删除指定侦听器的第一个匹配项。
`ChannelProgressivePromise`	`removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 为将来的每个听众删除第一个匹配项。
`ChannelProgressivePromise`	`setFailure(java.lang.Throwable cause)` 将这个未来标志为失败并通知所有听众。
`ChannelProgressivePromise`	`setProgress(long progress, long total)` 设置操作的当前进度并通知实现`GenericProgressiveFutureListener`的侦听器。
`ChannelProgressivePromise`	`setSuccess()`
`ChannelProgressivePromise`	`setSuccess(java.lang.Void result)` 将这个未来标志为成功并通知所有听众。
`ChannelProgressivePromise`	`sync()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`ChannelProgressivePromise`	`syncUninterruptibly()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`boolean`	`trySuccess()`
`ChannelProgressivePromise`	`unvoid()` 如果`ChannelFuture.isVoid()`本身返回`true`则返回新的`ChannelPromise` 。

Methods inherited from class io.netty.util.concurrent.DefaultProgressivePromise
tryProgress

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.ProgressivePromise
tryProgress

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

- 构造方法详细信息
  - DefaultChannelProgressivePromise
```
public DefaultChannelProgressivePromise(Channel channel)
```
    创建一个新的实例。
    
    参数
    
    channel - 与此未来相关的Channel
  - DefaultChannelProgressivePromise
```
public DefaultChannelProgressivePromise(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 ChannelProgressivePromise setSuccess()
```
    Specified by:
    
    setSuccess接口 ChannelProgressivePromise
    
    Specified by:
    
    setSuccess在界面 ChannelPromise
  - setSuccess
```
public ChannelProgressivePromise setSuccess(java.lang.Void result)
```
    从界面复制的描述： Promise
    
    将这个未来标志为成功并通知所有听众。如果它已经成功或失败，它会抛出IllegalStateException 。
    
    Specified by:
    
    setSuccess在界面 ChannelProgressivePromise
    
    Specified by:
    
    setSuccess在界面 ChannelPromise
    
    Specified by:
    
    setSuccess在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    setSuccess接口 Promise<java.lang.Void>
    
    重写：
    
    setSuccess在课堂 DefaultProgressivePromise<java.lang.Void>
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess在界面 ChannelPromise
  - setFailure
```
public ChannelProgressivePromise setFailure(java.lang.Throwable cause)
```
    从界面复制的描述： Promise
    
    将这个未来标志为失败并通知所有听众。如果它已经成功或失败，它会抛出一个IllegalStateException 。
    
    Specified by:
    
    setFailure在界面 ChannelProgressivePromise
    
    Specified by:
    
    setFailure在界面 ChannelPromise
    
    Specified by:
    
    setFailure在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    setFailure在界面 Promise<java.lang.Void>
    
    重写：
    
    setFailure在课堂上 DefaultProgressivePromise<java.lang.Void>
  - setProgress
```
public ChannelProgressivePromise setProgress(long progress,
                                             long total)
```
    从接口ProgressivePromise复制的描述
    
    设置操作的当前进度并通知实现GenericProgressiveFutureListener的侦听器。
    
    Specified by:
    
    setProgress在界面 ChannelProgressivePromise
    
    Specified by:
    
    setProgress在界面 ProgressivePromise<java.lang.Void>
    
    重写：
    
    setProgress DefaultProgressivePromise<java.lang.Void>
  - addListener
```
public ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    从界面复制的描述： Future
    
    将指定的侦听器添加到此将来。当这个未来完成时，通知指定的监听器。如果这个未来已经完成，立即通知指定的监听器。
    
    Specified by:
    
    addListener接口 ChannelFuture
    
    Specified by:
    
    addListener在界面 ChannelProgressiveFuture
    
    Specified by:
    
    addListener在界面 ChannelProgressivePromise
    
    Specified by:
    
    addListener在界面 ChannelPromise
    
    Specified by:
    
    addListener在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    addListener在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    addListener在界面 Promise<java.lang.Void>
    
    重写：
    
    addListener在课堂 DefaultProgressivePromise<java.lang.Void>
  - addListeners
```
public ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    从界面复制的描述： Future
    
    将指定的侦听器添加到此将来。这个未来完成时，通知指定的监听者。如果这个未来已经完成，则立即通知指定的监听者。
    
    Specified by:
    
    addListeners在界面 ChannelFuture
    
    Specified by:
    
    addListeners在界面 ChannelProgressiveFuture
    
    Specified by:
    
    addListeners在界面 ChannelProgressivePromise
    
    Specified by:
    
    addListeners在界面 ChannelPromise
    
    Specified by:
    
    addListeners在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    addListeners在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    addListeners在界面 Promise<java.lang.Void>
    
    重写：
    
    addListeners在课程 DefaultProgressivePromise<java.lang.Void>
  - removeListener
```
public ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)
```
    从接口复制的描述： Future
    
    从此将来删除指定侦听器的第一个匹配项。未来完成时，指定的监听器不再通知。如果指定的侦听器未与此将来关联，则此方法不执行任何操作并以静默方式返回。
    
    Specified by:
    
    removeListener在界面 ChannelFuture
    
    Specified by:
    
    removeListener接口 ChannelProgressiveFuture
    
    Specified by:
    
    removeListener在界面 ChannelProgressivePromise
    
    Specified by:
    
    removeListener在界面 ChannelPromise
    
    Specified by:
    
    removeListener在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    removeListener在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    removeListener在界面 Promise<java.lang.Void>
    
    重写：
    
    removeListener的 DefaultProgressivePromise<java.lang.Void>
  - removeListeners
```
public ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)
```
    从界面复制的描述： Future
    
    为将来的每个听众删除第一个匹配项。未来完成时，指定的监听器不再通知。如果指定的侦听器未与此将来关联，则此方法不执行任何操作并以静默方式返回。
    
    Specified by:
    
    removeListeners在界面 ChannelFuture
    
    Specified by:
    
    removeListeners在界面 ChannelProgressiveFuture
    
    Specified by:
    
    removeListeners在界面 ChannelProgressivePromise
    
    Specified by:
    
    removeListeners在界面 ChannelPromise
    
    Specified by:
    
    removeListeners在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    removeListeners在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    removeListeners ，界面 Promise<java.lang.Void>
    
    重写：
    
    removeListeners在课堂上 DefaultProgressivePromise<java.lang.Void>
  - sync
```
public ChannelProgressivePromise sync()
                               throws java.lang.InterruptedException
```
    从接口Future复制的描述
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    sync在界面 ChannelFuture
    
    Specified by:
    
    sync在界面 ChannelProgressiveFuture
    
    Specified by:
    
    sync在界面 ChannelProgressivePromise
    
    Specified by:
    
    sync在界面 ChannelPromise
    
    Specified by:
    
    sync在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    sync在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    sync在界面 Promise<java.lang.Void>
    
    重写：
    
    sync DefaultProgressivePromise<java.lang.Void>
    
    异常
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public ChannelProgressivePromise syncUninterruptibly()
```
    从界面复制的描述： Future
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    syncUninterruptibly ，界面 ChannelFuture
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelProgressiveFuture
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelProgressivePromise
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelPromise
    
    Specified by:
    
    syncUninterruptibly在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    syncUninterruptibly在界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    syncUninterruptibly在界面 Promise<java.lang.Void>
    
    重写：
    
    syncUninterruptibly DefaultProgressivePromise<java.lang.Void>
  - await
```
public ChannelProgressivePromise await()
                                throws java.lang.InterruptedException
```
    从接口Future复制的描述
    
    等待这个未来的完成。
    
    Specified by:
    
    await在界面 ChannelFuture
    
    Specified by:
    
    await在界面 ChannelProgressiveFuture
    
    Specified by:
    
    await接口 ChannelProgressivePromise
    
    Specified by:
    
    await在界面 ChannelPromise
    
    Specified by:
    
    await接口 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    await ，界面 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    await在界面 Promise<java.lang.Void>
    
    重写：
    
    await ，上课 DefaultProgressivePromise<java.lang.Void>
    
    异常
    
    java.lang.InterruptedException - 如果当前线程中断
  - awaitUninterruptibly
```
public ChannelProgressivePromise awaitUninterruptibly()
```
    从接口Future复制的描述
    
    等待这个未来不中断地完成。此方法捕获InterruptedException并以静默方式丢弃它。
    
    Specified by:
    
    awaitUninterruptibly在界面 ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly在界面 ChannelProgressiveFuture
    
    Specified by:
    
    awaitUninterruptibly在界面 ChannelProgressivePromise
    
    Specified by:
    
    awaitUninterruptibly在界面 ChannelPromise
    
    Specified by:
    
    awaitUninterruptibly在界面 ProgressiveFuture<java.lang.Void>
    
    Specified by:
    
    awaitUninterruptibly接口 ProgressivePromise<java.lang.Void>
    
    Specified by:
    
    awaitUninterruptibly在界面 Promise<java.lang.Void>
    
    重写：
    
    awaitUninterruptibly在课程 DefaultProgressivePromise<java.lang.Void>
  - flushCheckpoint
```
public long flushCheckpoint()
```
  - flushCheckpoint
```
public void flushCheckpoint(long checkpoint)
```
  - promise
```
public ChannelProgressivePromise promise()
```
  - checkDeadLock
```
protected void checkDeadLock()
```
    重写：
    
    checkDeadLock在课堂上 DefaultPromise<java.lang.Void>
  - unvoid
```
public ChannelProgressivePromise unvoid()
```
    从界面复制的描述： ChannelPromise
    
    如果ChannelFuture.isVoid()本身返回true则返回新的ChannelPromise 。
    
    Specified by:
    
    unvoid在界面 ChannelProgressivePromise
    
    Specified by:
    
    unvoid在界面 ChannelPromise
  - isVoid
```
public boolean isVoid()
```
    从界面复制的描述： ChannelFuture
    如果这ChannelFuture是一个无效的未来，并且不允许调用以下任何方法，则返回true ：
    Specified by:
    
    isVoid接口 ChannelFuture

Class DefaultChannelProgressivePromise

构造方法摘要

方法摘要

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

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.ProgressivePromise

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

构造方法详细信息

DefaultChannelProgressivePromise

DefaultChannelProgressivePromise

方法详细信息

executor

channel

setSuccess

setSuccess

trySuccess

setFailure

setProgress

addListener

addListeners

removeListener

removeListeners

sync

syncUninterruptibly

await

awaitUninterruptibly

flushCheckpoint

flushCheckpoint

promise

checkDeadLock

unvoid

isVoid