DefaultPromise (Netty 4.1.109.Final API文档

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

所有已实现的接口:

Promise<V>, java.util.concurrent.Future<V>

直接已知子类:

DefaultChannelPromise, DefaultProgressivePromise
```
public class DefaultPromise<V>
extends AbstractFuture<V>
implements Promise<V>
```

构造器概要

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

protected DefaultPromise()
See executor() for expectations of the executor.

DefaultPromise(EventExecutor executor)
Creates a new instance.

构造器
限定符	构造器和说明
`protected`	`DefaultPromise()` See `executor()` for expectations of the executor.
	`DefaultPromise(EventExecutor executor)` Creates a new instance.

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`Promise<V>`	`addListener(GenericFutureListener<? extends Future<? super V>> listener)` Adds the specified listener to this future.
`Promise<V>`	`addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Adds the specified listeners to this future.
`Promise<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.
`Promise<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`.
`java.lang.Throwable`	`cause()` Returns the cause of the failed I/O operation if the I/O operation has failed.
`protected void`	`checkDeadLock()`
`protected EventExecutor`	`executor()` Get the executor used to notify listeners when this promise is complete.
`V`	`get()`
`V`	`get(long timeout, java.util.concurrent.TimeUnit unit)`
`V`	`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.
`protected static void`	`notifyListener(EventExecutor eventExecutor, Future<?> future, GenericFutureListener<?> listener)` Notify a listener that a future has completed.
`Promise<V>`	`removeListener(GenericFutureListener<? extends Future<? super V>> listener)` Removes the first occurrence of the specified listener from this future.
`Promise<V>`	`removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Removes the first occurrence for each of the listeners from this future.
`Promise<V>`	`setFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`Promise<V>`	`setSuccess(V result)` Marks this future as a success and notifies all listeners.
`boolean`	`setUncancellable()` Make this future impossible to cancel.
`Promise<V>`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`Promise<V>`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`java.lang.String`	`toString()`
`protected java.lang.StringBuilder`	`toStringBuilder()`
`boolean`	`tryFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`trySuccess(V result)` Marks this future as a success and notifies all listeners.

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

- 构造器详细资料
  - DefaultPromise
```
public DefaultPromise(EventExecutor executor)
```
    Creates a new instance. It is preferable to use EventExecutor.newPromise() to create a new promise
    
    参数:
    
    executor - the EventExecutor which is used to notify the promise once it is complete. It is assumed this executor will protect against StackOverflowError exceptions. The executor may be used to avoid StackOverflowError by executing a Runnable if the stack depth exceeds a threshold.
  - DefaultPromise
```
protected DefaultPromise()
```
    See executor() for expectations of the executor.
- 方法详细资料
  - setSuccess
```
public Promise<V> setSuccess(V 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 在接口中 Promise<V>
  - trySuccess
```
public boolean trySuccess(V result)
```
    从接口复制的说明: Promise
    
    Marks this future as a success and notifies all listeners.
    
    指定者:
    
    trySuccess 在接口中 Promise<V>
    
    返回:
    
    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.
  - setFailure
```
public Promise<V> 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 在接口中 Promise<V>
  - tryFailure
```
public boolean tryFailure(java.lang.Throwable cause)
```
    从接口复制的说明: Promise
    
    Marks this future as a failure and notifies all listeners.
    
    指定者:
    
    tryFailure 在接口中 Promise<V>
    
    返回:
    
    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.
  - setUncancellable
```
public boolean setUncancellable()
```
    从接口复制的说明: Promise
    
    Make this future impossible to cancel.
    
    指定者:
    
    setUncancellable 在接口中 Promise<V>
    
    返回:
    
    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.
  - isSuccess
```
public boolean isSuccess()
```
    从接口复制的说明: Future
    
    Returns true if and only if the I/O operation was completed successfully.
  - isCancellable
```
public boolean isCancellable()
```
    从接口复制的说明: Future
    
    returns true if and only if the operation can be cancelled via Future.cancel(boolean).
  - 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.
  - addListener
```
public Promise<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.
    
    指定者:
    
    addListener 在接口中 Promise<V>
  - addListeners
```
public Promise<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.
    
    指定者:
    
    addListeners 在接口中 Promise<V>
  - removeListener
```
public Promise<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.
    
    指定者:
    
    removeListener 在接口中 Promise<V>
  - removeListeners
```
public Promise<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.
    
    指定者:
    
    removeListeners 在接口中 Promise<V>
  - await
```
public Promise<V> await()
                 throws java.lang.InterruptedException
```
    从接口复制的说明: Future
    
    Waits for this future to be completed.
    
    指定者:
    
    await 在接口中 Promise<V>
    
    抛出:
    
    java.lang.InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public Promise<V> awaitUninterruptibly()
```
    从接口复制的说明: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
    
    指定者:
    
    awaitUninterruptibly 在接口中 Promise<V>
  - 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
  - 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 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
  - getNow
```
public V 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.
  - get
```
public V get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException
```
    指定者:
    
    get 在接口中 java.util.concurrent.Future<V>
    
    覆盖:
    
    get 在类中 AbstractFuture<V>
    
    抛出:
    
    java.lang.InterruptedException
    
    java.util.concurrent.ExecutionException
  - get
```
public V get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException
```
    指定者:
    
    get 在接口中 java.util.concurrent.Future<V>
    
    覆盖:
    
    get 在类中 AbstractFuture<V>
    
    抛出:
    
    java.lang.InterruptedException
    
    java.util.concurrent.ExecutionException
    
    java.util.concurrent.TimeoutException
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    If the cancellation was successful it will fail the future with a CancellationException.
    
    指定者:
    
    cancel 在接口中 java.util.concurrent.Future<V>
    
    参数:
    
    mayInterruptIfRunning - this value has no effect in this implementation.
  - isCancelled
```
public boolean isCancelled()
```
    指定者:
    
    isCancelled 在接口中 java.util.concurrent.Future<V>
  - isDone
```
public boolean isDone()
```
    指定者:
    
    isDone 在接口中 java.util.concurrent.Future<V>
  - sync
```
public Promise<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.
    
    指定者:
    
    sync 在接口中 Promise<V>
    
    抛出:
    
    java.lang.InterruptedException
  - syncUninterruptibly
```
public Promise<V> syncUninterruptibly()
```
    从接口复制的说明: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
    
    指定者:
    
    syncUninterruptibly 在接口中 Promise<V>
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - toStringBuilder
```
protected java.lang.StringBuilder toStringBuilder()
```
  - executor
```
protected EventExecutor executor()
```
    Get the executor used to notify listeners when this promise is complete.
    It is assumed this executor will protect against StackOverflowError exceptions. The executor may be used to avoid StackOverflowError by executing a Runnable if the stack depth exceeds a threshold.
    
    返回:
    
    The executor used to notify listeners when this promise is complete.
  - checkDeadLock
```
protected void checkDeadLock()
```
  - notifyListener
```
protected static void notifyListener(EventExecutor eventExecutor,
                                     Future<?> future,
                                     GenericFutureListener<?> listener)
```
    Notify a listener that a future has completed.
    This method has a fixed depth of MAX_LISTENER_STACK_DEPTH that will limit recursion to prevent StackOverflowError and will stop notifying listeners added after this threshold is exceeded.
    
    参数:
    
    eventExecutor - the executor to use to notify the listener listener.
    
    future - the future that is complete.
    
    listener - the listener to notify.

类 DefaultPromise<V>

构造器概要

方法概要

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

构造器详细资料

DefaultPromise

DefaultPromise

方法详细资料

setSuccess

trySuccess

setFailure

tryFailure

setUncancellable

isSuccess

isCancellable

cause

addListener

addListeners

removeListener

removeListeners

await

awaitUninterruptibly

await

await

awaitUninterruptibly

awaitUninterruptibly

getNow

get

get

cancel

isCancelled

isDone

sync

syncUninterruptibly

toString

toStringBuilder

executor

checkDeadLock

notifyListener