ChannelProgressivePromise (Netty API Reference (4.1.22.Final))

All Superinterfaces:

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
```
特殊ChannelPromise ，一旦关联的字节正在传输，它将被通知。

方法摘要

所有方法接口方法抽象方法
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()` 等待这个未来不中断地完成。
`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()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`ChannelProgressivePromise`	`unvoid()` 返回一个新`ChannelPromise`如果`ChannelFuture.isVoid()`回报`true`否则本身。

Methods inherited from interface io.netty.util.concurrent.ProgressivePromise
tryProgress

Methods inherited from interface io.netty.channel.ChannelPromise
channel, trySuccess

Methods inherited from interface io.netty.channel.ChannelFuture
isVoid

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

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

Interface ChannelProgressivePromise

方法摘要

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

Methods inherited from interface io.netty.channel.ChannelPromise

Methods inherited from interface io.netty.channel.ChannelFuture

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

方法详细信息

addListener

addListeners

removeListener

removeListeners

sync

syncUninterruptibly

await

awaitUninterruptibly

setSuccess

setSuccess

setFailure

setProgress

unvoid