VoidChannelPromise (Netty 4.1.109.Final API文档

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

所有已实现的接口:

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
```

构造器概要

构造器
构造器和说明

VoidChannelPromise(Channel channel, boolean fireException)
Creates a new instance.

构造器
构造器和说明
`VoidChannelPromise(Channel channel, boolean fireException)` Creates a new instance.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`VoidChannelPromise`	`addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` Adds the specified listener to this future.
`VoidChannelPromise`	`addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` Adds the specified listeners to this future.
`VoidChannelPromise`	`await()` Waits for this future to be completed.
`boolean`	`await(long timeoutMillis)` Waits for this future to be completed within the specified time limit.
`boolean`	`await(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit.
`VoidChannelPromise`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`boolean`	`awaitUninterruptibly(long timeoutMillis)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`cancel(boolean mayInterruptIfRunning)` If the cancellation was successful it will fail the future with a `CancellationException`.
`java.lang.Throwable`	`cause()` Returns the cause of the failed I/O operation if the I/O operation has failed.
`Channel`	`channel()` Returns a channel where the I/O operation associated with this future takes place.
`java.lang.Void`	`getNow()` Return the result without blocking.
`boolean`	`isCancellable()` returns `true` if and only if the operation can be cancelled via `Future.cancel(boolean)`.
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`boolean`	`isSuccess()` Returns `true` if and only if the I/O operation was completed successfully.
`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()`
`VoidChannelPromise`	`removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)` Removes the first occurrence of the specified listener from this future.
`VoidChannelPromise`	`removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`VoidChannelPromise`	`setFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`VoidChannelPromise`	`setSuccess()`
`VoidChannelPromise`	`setSuccess(java.lang.Void result)` Marks this future as a success and notifies all listeners.
`boolean`	`setUncancellable()` Make this future impossible to cancel.
`VoidChannelPromise`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`VoidChannelPromise`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`boolean`	`tryFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`trySuccess()`
`boolean`	`trySuccess(java.lang.Void result)` Marks this future as a success and notifies all listeners.
`ChannelPromise`	`unvoid()` Returns a new `ChannelPromise` if `ChannelFuture.isVoid()` returns `true` otherwise itself.

从类继承的方法 io.netty.util.concurrent.AbstractFuture
get, get

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

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

- 构造器详细资料
  - VoidChannelPromise
```
public VoidChannelPromise(Channel channel,
                          boolean fireException)
```
    Creates a new instance.
    
    参数:
    
    channel - the Channel associated with this future
- 方法详细资料
  - addListener
```
public VoidChannelPromise 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>
  - addListeners
```
public VoidChannelPromise 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>
  - removeListener
```
public VoidChannelPromise 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>
  - removeListeners
```
public VoidChannelPromise 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>
  - await
```
public VoidChannelPromise await()
                         throws java.lang.InterruptedException
```
    从接口复制的说明: Future
    
    Waits for this future to be completed.
    
    指定者:
    
    await 在接口中 ChannelFuture
    
    指定者:
    
    await 在接口中 ChannelPromise
    
    指定者:
    
    await 在接口中 Promise<java.lang.Void>
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - await
```
public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
```
    从接口复制的说明: Future
    
    Waits for this future to be completed within the specified time limit.
    
    返回:
    
    true if and only if the future was completed within the specified time limit
  - await
```
public boolean await(long timeoutMillis)
```
    从接口复制的说明: Future
    
    Waits for this future to be completed within the specified time limit.
    
    返回:
    
    true if and only if the future was completed within the specified time limit
  - awaitUninterruptibly
```
public VoidChannelPromise 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
```
public boolean awaitUninterruptibly(long timeout,
                                    java.util.concurrent.TimeUnit unit)
```
    从接口复制的说明: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    返回:
    
    true if and only if the future was completed within the specified time limit
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeoutMillis)
```
    从接口复制的说明: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    返回:
    
    true if and only if the future was completed within the specified time limit
  - channel
```
public Channel channel()
```
    从接口复制的说明: ChannelFuture
    
    Returns a channel where the I/O operation associated with this future takes place.
    
    指定者:
    
    channel 在接口中 ChannelFuture
    
    指定者:
    
    channel 在接口中 ChannelPromise
  - isDone
```
public boolean isDone()
```
    指定者:
    
    isDone 在接口中 java.util.concurrent.Future<java.lang.Void>
  - isSuccess
```
public boolean isSuccess()
```
    从接口复制的说明: Future
    
    Returns true if and only if the I/O operation was completed successfully.
  - setUncancellable
```
public boolean setUncancellable()
```
    从接口复制的说明: Promise
    
    Make this future impossible to cancel.
    
    指定者:
    
    setUncancellable 在接口中 Promise<java.lang.Void>
    
    返回:
    
    true if and only if successfully marked this future as uncancellable or it is already done without being cancelled. false if this future has been cancelled already.
  - isCancellable
```
public boolean isCancellable()
```
    从接口复制的说明: Future
    
    returns true if and only if the operation can be cancelled via Future.cancel(boolean).
  - isCancelled
```
public boolean isCancelled()
```
    指定者:
    
    isCancelled 在接口中 java.util.concurrent.Future<java.lang.Void>
  - cause
```
public java.lang.Throwable cause()
```
    从接口复制的说明: Future
    
    Returns the cause of the failed I/O operation if the I/O operation has failed.
    
    返回:
    
    the cause of the failure. null if succeeded or this future is not completed yet.
  - sync
```
public VoidChannelPromise sync()
```
    从接口复制的说明: 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>
  - syncUninterruptibly
```
public VoidChannelPromise 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>
  - setFailure
```
public VoidChannelPromise 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>
  - setSuccess
```
public VoidChannelPromise setSuccess()
```
    指定者:
    
    setSuccess 在接口中 ChannelPromise
  - tryFailure
```
public boolean tryFailure(java.lang.Throwable cause)
```
    从接口复制的说明: Promise
    
    Marks this future as a failure and notifies all listeners.
    
    指定者:
    
    tryFailure 在接口中 Promise<java.lang.Void>
    
    返回:
    
    true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    If the cancellation was successful it will fail the future with a CancellationException.
    
    指定者:
    
    cancel 在接口中 java.util.concurrent.Future<java.lang.Void>
    
    参数:
    
    mayInterruptIfRunning - this value has no effect in this implementation.
  - trySuccess
```
public boolean trySuccess()
```
    指定者:
    
    trySuccess 在接口中 ChannelPromise
  - setSuccess
```
public VoidChannelPromise 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>
  - trySuccess
```
public boolean trySuccess(java.lang.Void result)
```
    从接口复制的说明: Promise
    
    Marks this future as a success and notifies all listeners.
    
    指定者:
    
    trySuccess 在接口中 Promise<java.lang.Void>
    
    返回:
    
    true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.
  - getNow
```
public java.lang.Void getNow()
```
    从接口复制的说明: Future
    
    Return the result without blocking. If the future is not done yet this will return null. As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not rely on the returned null value.
  - 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

类 VoidChannelPromise

构造器概要

方法概要

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

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

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