VoidChannelPromise (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.concurrent.AbstractFuture<java.lang.Void>
- - io.netty.channel.VoidChannelPromise

All Implemented Interfaces:

ChannelFuture ， ChannelPromise ， Promise <java.lang.Void的>，java.util.concurrent.Future <java.lang.Void的>
```
@UnstableApi
public final class VoidChannelPromise
extends AbstractFuture<java.lang.Void>
implements ChannelPromise
```

构造方法摘要

构造方法
Constructor and Description
`VoidChannelPromise(Channel channel, boolean fireException)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`VoidChannelPromise`	`addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` 将指定的侦听器添加到此将来。
`VoidChannelPromise`	`addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 将指定的侦听器添加到此将来。
`VoidChannelPromise`	`await()` 等待这个未来的完成。
`boolean`	`await(long timeoutMillis)` 等待这个未来在规定的时限内完成。
`boolean`	`await(long timeout, java.util.concurrent.TimeUnit unit)` 等待这个未来在规定的时限内完成。
`VoidChannelPromise`	`awaitUninterruptibly()` 等待这个未来不中断地完成。
`boolean`	`awaitUninterruptibly(long timeoutMillis)` 等待这个未来在规定的时间内完成而不会中断。
`boolean`	`awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit)` 等待这个未来在规定的时间内完成而不会中断。
`boolean`	`cancel(boolean mayInterruptIfRunning)` 如果取消成功，它将以 `CancellationException`未来失败。
`java.lang.Throwable`	`cause()` 如果I / O操作失败，则返回失败的I / O操作的原因。
`Channel`	`channel()` 返回与此未来相关的I / O操作发生的通道。
`java.lang.Void`	`getNow()` 无阻塞地返回结果。
`boolean`	`isCancellable()` 返回 `true`当且仅当该操作可通过取消 `Future.cancel(boolean)` 。
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`boolean`	`isSuccess()` 当且仅当I / O操作成功完成时返回 `true` 。
`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()`
`VoidChannelPromise`	`removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` 从此将来删除指定侦听器的第一个匹配项。
`VoidChannelPromise`	`removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` 为将来的每个听众删除第一个匹配项。
`VoidChannelPromise`	`setFailure(java.lang.Throwable cause)` 将这个未来标志为失败并通知所有听众。
`VoidChannelPromise`	`setSuccess()`
`VoidChannelPromise`	`setSuccess(java.lang.Void result)` 将这个未来标志为成功并通知所有听众。
`boolean`	`setUncancellable()` 使这个未来无法取消。
`VoidChannelPromise`	`sync()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`VoidChannelPromise`	`syncUninterruptibly()` 等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
`boolean`	`tryFailure(java.lang.Throwable cause)` 将这个未来标志为失败并通知所有听众。
`boolean`	`trySuccess()`
`boolean`	`trySuccess(java.lang.Void result)` 将这个未来标志为成功并通知所有听众。
`ChannelPromise`	`unvoid()` 返回一个新`ChannelPromise`如果`ChannelFuture.isVoid()`回报`true`否则本身。

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, toString, wait, wait, wait

Methods inherited from interface java.util.concurrent.Future
get, get

- 构造方法详细信息
  - VoidChannelPromise
```
public VoidChannelPromise(Channel channel,
                          boolean fireException)
```
    创建一个新的实例。
    
    参数
    
    channel - 与此未来相关的Channel
- 方法详细信息
  - addListener
```
public VoidChannelPromise 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>
  - addListeners
```
public VoidChannelPromise 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>
  - removeListener
```
public VoidChannelPromise 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>
  - removeListeners
```
public VoidChannelPromise 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>
  - await
```
public VoidChannelPromise await()
                         throws java.lang.InterruptedException
```
    从接口复制的描述： Future
    
    等待这个未来的完成。
    
    Specified by:
    
    await在界面 ChannelFuture
    
    Specified by:
    
    await在界面 ChannelPromise
    
    Specified by:
    
    await在界面 Promise<java.lang.Void>
    
    异常
    
    java.lang.InterruptedException - 如果当前线程中断
  - await
```
public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
```
    从接口复制的描述： Future
    
    等待这个未来在规定的时限内完成。
    
    结果
    
    true当且仅当未来在规定的时限内完成
  - await
```
public boolean await(long timeoutMillis)
```
    从接口复制的描述： Future
    
    等待这个未来在规定的时限内完成。
    
    结果
    
    true当且仅当未来在规定的时限内完成
  - awaitUninterruptibly
```
public VoidChannelPromise awaitUninterruptibly()
```
    从接口复制的描述： Future
    
    等待这个未来不中断地完成。此方法捕获InterruptedException并以静默方式丢弃它。
    
    Specified by:
    
    awaitUninterruptibly在界面 ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly接口 ChannelPromise
    
    Specified by:
    
    awaitUninterruptibly在界面 Promise<java.lang.Void>
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeout,
                                    java.util.concurrent.TimeUnit unit)
```
    从接口复制的描述： Future
    
    等待这个未来在规定的时间内完成而不会中断。此方法捕获一个InterruptedException并以静默方式丢弃它。
    
    结果
    
    true当且仅当未来是在规定的期限内完成
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeoutMillis)
```
    从接口复制的描述： Future
    
    等待这个未来在规定的时间内完成而不会中断。此方法捕获InterruptedException并以静默方式丢弃它。
    
    结果
    
    true当且仅当未来在规定的时限内完成
  - channel
```
public Channel channel()
```
    从接口复制的描述： ChannelFuture
    
    返回与此未来相关的I / O操作发生的通道。
    
    Specified by:
    
    channel接口 ChannelFuture
    
    Specified by:
    
    channel在界面 ChannelPromise
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone在界面 java.util.concurrent.Future<java.lang.Void>
  - isSuccess
```
public boolean isSuccess()
```
    从界面复制的描述： Future
    
    当且仅当I / O操作成功完成时返回 true 。
  - setUncancellable
```
public boolean setUncancellable()
```
    从接口复制的描述： Promise
    
    使这个未来无法取消。
    
    Specified by:
    
    setUncancellable接口 Promise<java.lang.Void>
    
    结果
    
    true当且仅当成功地将这个未来标记为不可撤销或已经完成而未被取消。 false如果这个未来已被取消。
  - isCancellable
```
public boolean isCancellable()
```
    从接口复制的描述： Future
    
    返回 true当且仅当该操作可通过取消 Future.cancel(boolean) 。
  - isCancelled
```
public boolean isCancelled()
```
    Specified by:
    
    isCancelled在界面 java.util.concurrent.Future<java.lang.Void>
  - cause
```
public java.lang.Throwable cause()
```
    从接口复制的描述： Future
    
    如果I / O操作失败，则返回失败的I / O操作的原因。
    
    结果
    
    失败的原因。 null如果成功或未来尚未完成。
  - sync
```
public VoidChannelPromise sync()
```
    从接口复制的描述： Future
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    sync在界面 ChannelFuture
    
    Specified by:
    
    sync接口 ChannelPromise
    
    Specified by:
    
    sync在界面 Promise<java.lang.Void>
  - syncUninterruptibly
```
public VoidChannelPromise syncUninterruptibly()
```
    从接口复制的描述： Future
    
    等待这个未来，直到完成，并且在这个未来失败的时候重新引发失败的原因。
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelFuture
    
    Specified by:
    
    syncUninterruptibly在界面 ChannelPromise
    
    Specified by:
    
    syncUninterruptibly在界面 Promise<java.lang.Void>
  - setFailure
```
public VoidChannelPromise setFailure(java.lang.Throwable cause)
```
    从接口复制的描述： Promise
    
    将这个未来标志为失败并通知所有听众。如果已经成功或失败，它会抛出IllegalStateException 。
    
    Specified by:
    
    setFailure在界面 ChannelPromise
    
    Specified by:
    
    setFailure在界面 Promise<java.lang.Void>
  - setSuccess
```
public VoidChannelPromise setSuccess()
```
    Specified by:
    
    setSuccess在界面 ChannelPromise
  - tryFailure
```
public boolean tryFailure(java.lang.Throwable cause)
```
    从接口复制的描述： Promise
    
    将这个未来标志为失败并通知所有听众。
    
    Specified by:
    
    tryFailure在界面 Promise<java.lang.Void>
    
    结果
    
    true当且仅当成功将这个未来标记为失败。否则false因为这个未来已被标记为成功或失败。
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    如果取消成功，将会以 CancellationException失败。
    
    Specified by:
    
    cancel接口 java.util.concurrent.Future<java.lang.Void>
    
    参数
    
    mayInterruptIfRunning - 此值在此实现中不起作用。
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess在界面 ChannelPromise
  - setSuccess
```
public VoidChannelPromise setSuccess(java.lang.Void result)
```
    从接口复制的描述： Promise
    
    将这个未来标志为成功并通知所有听众。如果它已经成功或失败，它会抛出IllegalStateException 。
    
    Specified by:
    
    setSuccess ，界面 ChannelPromise
    
    Specified by:
    
    setSuccess接口 Promise<java.lang.Void>
  - trySuccess
```
public boolean trySuccess(java.lang.Void result)
```
    从接口复制的描述： Promise
    
    将这个未来标志为成功并通知所有听众。
    
    Specified by:
    
    trySuccess在界面 Promise<java.lang.Void>
    
    结果
    
    true当且仅当成功标记这个未来。否则false因为这个未来已被标记为成功或失败。
  - getNow
```
public java.lang.Void getNow()
```
    从接口复制的描述： Future
    
    无阻塞地返回结果。如果未来还没有完成，这将返回null 。由于可能使用null值标记未来成功，因此还需要检查未来是否真的用Future.isDone()完成，而不是在返回的null值上继电器。
  - 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 VoidChannelPromise

构造方法摘要

方法摘要

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.Future

构造方法详细信息

VoidChannelPromise

方法详细信息

addListener

addListeners

removeListener

removeListeners

await

await

await

awaitUninterruptibly

awaitUninterruptibly

awaitUninterruptibly

channel

isDone

isSuccess

setUncancellable

isCancellable

isCancelled

cause

sync

syncUninterruptibly

setFailure

setSuccess

tryFailure

cancel

trySuccess

setSuccess

trySuccess

getNow

unvoid

isVoid