Class DefaultChannelPromise

java.lang.Object

io.netty.util.concurrent.AbstractFuture<java.lang.Void>

io.netty.util.concurrent.DefaultPromise<java.lang.Void>

io.netty.channel.DefaultChannelPromise

All Implemented Interfaces:

ChannelFlushPromiseNotifier.FlushCheckpoint, ChannelFuture, ChannelPromise, Future<java.lang.Void>, Promise<java.lang.Void>, java.util.concurrent.Future<java.lang.Void>

Direct Known Subclasses:

AbstractBootstrap.PendingRegistrationPromise, AbstractChannel.CloseFuture, Http2CodecUtil.SimpleChannelPromiseAggregator

public class DefaultChannelPromise
extends DefaultPromise<java.lang.Void>
implements ChannelPromise, ChannelFlushPromiseNotifier.FlushCheckpoint

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

Modifier and Type	Field	Description
private final Channel	channel
private long	checkpoint

Fields inherited from class DefaultPromise

PROPERTY_MAX_LISTENER_STACK_DEPTH

Constructor Summary

Constructors

Constructor	Description
DefaultChannelPromise(Channel channel)	Creates a new instance.
DefaultChannelPromise(Channel channel, EventExecutor executor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ChannelPromise	addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)	Adds the specified listener to this future.
ChannelPromise	addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)	Adds the specified listeners to this future.
ChannelPromise	await()	Waits for this future to be completed.
ChannelPromise	awaitUninterruptibly()	Waits for this future to be completed without interruption.
Channel	channel()	Returns a channel where the I/O operation associated with this future takes place.
protected void	checkDeadLock()
protected EventExecutor	executor()	Get the executor used to notify listeners when this promise is complete.
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(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)	Removes the first occurrence of the specified listener from this future.
ChannelPromise	removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)	Removes the first occurrence for each of the listeners from this future.
ChannelPromise	setFailure(java.lang.Throwable cause)	Marks this future as a failure and notifies all listeners.
ChannelPromise	setSuccess()
ChannelPromise	setSuccess(java.lang.Void result)	Marks this future as a success and notifies all listeners.
ChannelPromise	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelPromise	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
boolean	trySuccess()
ChannelPromise	unvoid()	Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.

Methods inherited from class 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 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 Promise

setUncancellable, tryFailure, trySuccess

Field Details

channel

private final Channel channel

checkpoint

private long checkpoint

Constructor Details

DefaultChannelPromise

public DefaultChannelPromise(Channel channel)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

DefaultChannelPromise

public DefaultChannelPromise(Channel channel,
 EventExecutor executor)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

Method Details

executor

protected EventExecutor executor()

Description copied from class: DefaultPromise

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.

Overrides:

executor in class DefaultPromise<java.lang.Void>

Returns:

The executor used to notify listeners when this promise is complete.

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(java.lang.Void result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Specified by:

setSuccess in interface ChannelPromise

Specified by:

setSuccess in interface Promise<java.lang.Void>

Overrides:

setSuccess in class DefaultPromise<java.lang.Void>

trySuccess

public boolean trySuccess()

Specified by:

trySuccess in interface ChannelPromise

setFailure

public ChannelPromise setFailure(java.lang.Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Specified by:

setFailure in interface ChannelPromise

Specified by:

setFailure in interface Promise<java.lang.Void>

Overrides:

setFailure in class DefaultPromise<java.lang.Void>

addListener

public ChannelPromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

Description copied from interface: 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.

Specified by:

addListener in interface ChannelFuture

Specified by:

addListener in interface ChannelPromise

Specified by:

addListener in interface Future<java.lang.Void>

Specified by:

addListener in interface Promise<java.lang.Void>

Overrides:

addListener in class DefaultPromise<java.lang.Void>

addListeners

public ChannelPromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

Description copied from interface: 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.

Specified by:

addListeners in interface ChannelFuture

Specified by:

addListeners in interface ChannelPromise

Specified by:

addListeners in interface Future<java.lang.Void>

Specified by:

addListeners in interface Promise<java.lang.Void>

Overrides:

addListeners in class DefaultPromise<java.lang.Void>

removeListener

public ChannelPromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

Description copied from interface: 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.

Specified by:

removeListener in interface ChannelFuture

Specified by:

removeListener in interface ChannelPromise

Specified by:

removeListener in interface Future<java.lang.Void>

Specified by:

removeListener in interface Promise<java.lang.Void>

Overrides:

removeListener in class DefaultPromise<java.lang.Void>

removeListeners

public ChannelPromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

Description copied from interface: 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.

Specified by:

removeListeners in interface ChannelFuture

Specified by:

removeListeners in interface ChannelPromise

Specified by:

removeListeners in interface Future<java.lang.Void>

Specified by:

removeListeners in interface Promise<java.lang.Void>

Overrides:

removeListeners in class DefaultPromise<java.lang.Void>

sync

public ChannelPromise sync()
                    throws java.lang.InterruptedException

Description copied from interface: Future

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

sync in interface ChannelFuture

Specified by:

sync in interface ChannelPromise

Specified by:

sync in interface Future<java.lang.Void>

Specified by:

sync in interface Promise<java.lang.Void>

Overrides:

sync in class DefaultPromise<java.lang.Void>

Throws:

java.lang.InterruptedException

syncUninterruptibly

public ChannelPromise syncUninterruptibly()

Description copied from interface: Future

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

syncUninterruptibly in interface ChannelFuture

Specified by:

syncUninterruptibly in interface ChannelPromise

Specified by:

syncUninterruptibly in interface Future<java.lang.Void>

Specified by:

syncUninterruptibly in interface Promise<java.lang.Void>

Overrides:

syncUninterruptibly in class DefaultPromise<java.lang.Void>

await

public ChannelPromise await()
                     throws java.lang.InterruptedException

Description copied from interface: Future

Waits for this future to be completed.

Specified by:

await in interface ChannelFuture

Specified by:

await in interface ChannelPromise

Specified by:

await in interface Future<java.lang.Void>

Specified by:

await in interface Promise<java.lang.Void>

Overrides:

await in class DefaultPromise<java.lang.Void>

Throws:

java.lang.InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public ChannelPromise awaitUninterruptibly()

Description copied from interface: Future

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface ChannelFuture

Specified by:

awaitUninterruptibly in interface ChannelPromise

Specified by:

awaitUninterruptibly in interface Future<java.lang.Void>

Specified by:

awaitUninterruptibly in interface Promise<java.lang.Void>

Overrides:

awaitUninterruptibly in class DefaultPromise<java.lang.Void>

flushCheckpoint

public long flushCheckpoint()

Specified by:

flushCheckpoint in interface ChannelFlushPromiseNotifier.FlushCheckpoint

flushCheckpoint

public void flushCheckpoint(long checkpoint)

Specified by:

flushCheckpoint in interface ChannelFlushPromiseNotifier.FlushCheckpoint

promise

public ChannelPromise promise()

Specified by:

promise in interface ChannelFlushPromiseNotifier.FlushCheckpoint

checkDeadLock

protected void checkDeadLock()

Overrides:

checkDeadLock in class DefaultPromise<java.lang.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