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

All Implemented Interfaces:

ChannelFuture, ChannelPromise, io.netty.util.concurrent.Future<Void>, io.netty.util.concurrent.Promise<Void>, Future<Void>
```
public class DefaultChannelPromise
extends io.netty.util.concurrent.DefaultPromise<Void>
implements ChannelPromise
```
The default ChannelPromise implementation. It is recommended to use Channel.newPromise() to create a new ChannelPromise rather than calling the constructor explicitly.

Field Summary
- Fields inherited from class io.netty.util.concurrent.DefaultPromise
  PROPERTY_MAX_LISTENER_STACK_DEPTH

Constructor Summary

Constructors
Constructor	Description
`DefaultChannelPromise(Channel channel)`	Creates a new instance.
`DefaultChannelPromise(Channel channel, io.netty.util.concurrent.EventExecutor executor)`	Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ChannelPromise`	`addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)`
`ChannelPromise`	`addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)`
`ChannelPromise`	`await()`
`ChannelPromise`	`awaitUninterruptibly()`
`Channel`	`channel()`	Returns a channel where the I/O operation associated with this future takes place.
`protected void`	`checkDeadLock()`
`protected io.netty.util.concurrent.EventExecutor`	`executor()`
`long`	`flushCheckpoint()`
`void`	`flushCheckpoint(long checkpoint)`
`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()`
`ChannelPromise`	`promise()`
`ChannelPromise`	`removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)`
`ChannelPromise`	`removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)`
`ChannelPromise`	`setFailure(Throwable cause)`
`ChannelPromise`	`setSuccess()`
`ChannelPromise`	`setSuccess(Void result)`
`ChannelPromise`	`sync()`
`ChannelPromise`	`syncUninterruptibly()`
`boolean`	`trySuccess()`
`ChannelPromise`	`unvoid()`	Returns a new `ChannelPromise` if `ChannelFuture.isVoid()` returns `true` otherwise itself.

Methods inherited from class io.netty.util.concurrent.DefaultPromise
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface io.netty.util.concurrent.Promise
setUncancellable, tryFailure, trySuccess

- Constructor Detail
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel)
```
    Creates a new instance.
    
    Parameters:
    
    channel - the Channel associated with this future
  - DefaultChannelPromise
```
public DefaultChannelPromise(Channel channel,
                             io.netty.util.concurrent.EventExecutor executor)
```
    Creates a new instance.
    
    Parameters:
    
    channel - the Channel associated with this future
- Method Detail
  - executor
```
protected io.netty.util.concurrent.EventExecutor executor()
```
    Overrides:
    
    executor in class io.netty.util.concurrent.DefaultPromise<Void>
  - channel
```
public Channel channel()
```
    Description copied from interface: ChannelFuture
    
    Returns a channel where the I/O operation associated with this future takes place.
    
    Specified by:
    
    channel in interface ChannelFuture
    
    Specified by:
    
    channel in interface ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess()
```
    Specified by:
    
    setSuccess in interface ChannelPromise
  - setSuccess
```
public ChannelPromise setSuccess(Void result)
```
    Specified by:
    
    setSuccess in interface ChannelPromise
    
    Specified by:
    
    setSuccess in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    setSuccess in class io.netty.util.concurrent.DefaultPromise<Void>
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess in interface ChannelPromise
  - setFailure
```
public ChannelPromise setFailure(Throwable cause)
```
    Specified by:
    
    setFailure in interface ChannelPromise
    
    Specified by:
    
    setFailure in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    setFailure in class io.netty.util.concurrent.DefaultPromise<Void>
  - addListener
```
public ChannelPromise addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
```
    Specified by:
    
    addListener in interface ChannelFuture
    
    Specified by:
    
    addListener in interface ChannelPromise
    
    Specified by:
    
    addListener in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    addListener in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    addListener in class io.netty.util.concurrent.DefaultPromise<Void>
  - addListeners
```
public ChannelPromise addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
```
    Specified by:
    
    addListeners in interface ChannelFuture
    
    Specified by:
    
    addListeners in interface ChannelPromise
    
    Specified by:
    
    addListeners in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    addListeners in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    addListeners in class io.netty.util.concurrent.DefaultPromise<Void>
  - removeListener
```
public ChannelPromise removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
```
    Specified by:
    
    removeListener in interface ChannelFuture
    
    Specified by:
    
    removeListener in interface ChannelPromise
    
    Specified by:
    
    removeListener in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    removeListener in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    removeListener in class io.netty.util.concurrent.DefaultPromise<Void>
  - removeListeners
```
public ChannelPromise removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
```
    Specified by:
    
    removeListeners in interface ChannelFuture
    
    Specified by:
    
    removeListeners in interface ChannelPromise
    
    Specified by:
    
    removeListeners in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    removeListeners in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    removeListeners in class io.netty.util.concurrent.DefaultPromise<Void>
  - sync
```
public ChannelPromise sync()
                    throws InterruptedException
```
    Specified by:
    
    sync in interface ChannelFuture
    
    Specified by:
    
    sync in interface ChannelPromise
    
    Specified by:
    
    sync in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    sync in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    sync in class io.netty.util.concurrent.DefaultPromise<Void>
    
    Throws:
    
    InterruptedException
  - syncUninterruptibly
```
public ChannelPromise syncUninterruptibly()
```
    Specified by:
    
    syncUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    syncUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    syncUninterruptibly in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    syncUninterruptibly in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    syncUninterruptibly in class io.netty.util.concurrent.DefaultPromise<Void>
  - await
```
public ChannelPromise await()
                     throws InterruptedException
```
    Specified by:
    
    await in interface ChannelFuture
    
    Specified by:
    
    await in interface ChannelPromise
    
    Specified by:
    
    await in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    await in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    await in class io.netty.util.concurrent.DefaultPromise<Void>
    
    Throws:
    
    InterruptedException
  - awaitUninterruptibly
```
public ChannelPromise awaitUninterruptibly()
```
    Specified by:
    
    awaitUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    awaitUninterruptibly in interface io.netty.util.concurrent.Future<Void>
    
    Specified by:
    
    awaitUninterruptibly in interface io.netty.util.concurrent.Promise<Void>
    
    Overrides:
    
    awaitUninterruptibly in class io.netty.util.concurrent.DefaultPromise<Void>
  - flushCheckpoint
```
public long flushCheckpoint()
```
  - flushCheckpoint
```
public void flushCheckpoint(long checkpoint)
```
  - promise
```
public ChannelPromise promise()
```
  - checkDeadLock
```
protected void checkDeadLock()
```
    Overrides:
    
    checkDeadLock in class io.netty.util.concurrent.DefaultPromise<Void>
  - unvoid
```
public ChannelPromise unvoid()
```
    Description copied from interface: ChannelPromise
    
    Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.
    
    Specified by:
    
    unvoid in interface ChannelPromise
  - isVoid
```
public boolean isVoid()
```
    Description copied from interface: ChannelFuture
    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()
    Specified by:
    
    isVoid in interface ChannelFuture

Class DefaultChannelPromise

Field Summary

Fields inherited from class io.netty.util.concurrent.DefaultPromise

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Future

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

Constructor Detail

DefaultChannelPromise

DefaultChannelPromise

Method Detail

executor

channel

setSuccess

setSuccess

trySuccess

setFailure

addListener

addListeners

removeListener

removeListeners

sync

syncUninterruptibly

await

awaitUninterruptibly

flushCheckpoint

flushCheckpoint

promise

checkDeadLock

unvoid

isVoid