CompleteFuture (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.util.concurrent.AbstractFuture<V>
- - io.netty.util.concurrent.CompleteFuture<V>

所有已实现的接口:

java.util.concurrent.Future<V>

直接已知子类:

FailedFuture, SucceededFuture
```
public abstract class CompleteFuture<V>
extends AbstractFuture<V>
```
A skeletal Future implementation which represents a Future which has been completed already.

构造器概要

构造器
限定符构造器和说明

protected CompleteFuture(EventExecutor executor)
Creates a new instance.

构造器
限定符	构造器和说明
`protected`	`CompleteFuture(EventExecutor executor)` Creates a new instance.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`Future<V>`	`addListener(GenericFutureListener<? extends Future<? super V>> listener)` Adds the specified listener to this future.
`Future<V>`	`addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Adds the specified listeners to this future.
`Future<V>`	`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.
`Future<V>`	`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`.
`protected EventExecutor`	`executor()` Return the `EventExecutor` which is used by this `CompleteFuture`.
`boolean`	`isCancellable()` returns `true` if and only if the operation can be cancelled via `Future.cancel(boolean)`.
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`Future<V>`	`removeListener(GenericFutureListener<? extends Future<? super V>> listener)` Removes the first occurrence of the specified listener from this future.
`Future<V>`	`removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`Future<V>`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`Future<V>`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

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

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

从接口继承的方法 io.netty.util.concurrent.Future
cause, getNow, isSuccess

- 构造器详细资料
  - CompleteFuture
```
protected CompleteFuture(EventExecutor executor)
```
    Creates a new instance.
    
    参数:
    
    executor - the EventExecutor associated with this future
- 方法详细资料
  - executor
```
protected EventExecutor executor()
```
    Return the EventExecutor which is used by this CompleteFuture.
  - addListener
```
public Future<V> addListener(GenericFutureListener<? extends Future<? super V>> 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.
  - addListeners
```
public Future<V> addListeners(GenericFutureListener<? extends Future<? super V>>... 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.
  - removeListener
```
public Future<V> removeListener(GenericFutureListener<? extends Future<? super V>> 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.
  - removeListeners
```
public Future<V> removeListeners(GenericFutureListener<? extends Future<? super V>>... 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.
  - await
```
public Future<V> await()
                throws java.lang.InterruptedException
```
    从接口复制的说明: Future
    
    Waits for this future to be completed.
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - await
```
public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException
```
    从接口复制的说明: 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
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - sync
```
public Future<V> sync()
               throws java.lang.InterruptedException
```
    从接口复制的说明: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
    
    抛出:
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public Future<V> syncUninterruptibly()
```
    从接口复制的说明: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
  - await
```
public boolean await(long timeoutMillis)
              throws java.lang.InterruptedException
```
    从接口复制的说明: 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
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public Future<V> awaitUninterruptibly()
```
    从接口复制的说明: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
  - 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
  - isDone
```
public boolean isDone()
```
  - isCancellable
```
public boolean isCancellable()
```
    从接口复制的说明: Future
    
    returns true if and only if the operation can be cancelled via Future.cancel(boolean).
  - isCancelled
```
public boolean isCancelled()
```
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    If the cancellation was successful it will fail the future with a CancellationException.
    
    参数:
    
    mayInterruptIfRunning - this value has no effect in this implementation.

类 CompleteFuture<V>

构造器概要

方法概要

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

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

从接口继承的方法 io.netty.util.concurrent.Future

构造器详细资料

CompleteFuture

方法详细资料

executor

addListener

addListeners

removeListener

removeListeners

await

await

sync

syncUninterruptibly

await

awaitUninterruptibly

awaitUninterruptibly

awaitUninterruptibly

isDone

isCancellable

isCancelled

cancel