Package io.netty.channel
Class DefaultChannelPromise
- java.lang.Object
-
- io.netty.util.concurrent.AbstractFuture<V>
-
- io.netty.util.concurrent.DefaultPromise<java.lang.Void>
-
- io.netty.channel.DefaultChannelPromise
-
- All Implemented Interfaces:
ChannelFuture
,ChannelPromise
,Future<java.lang.Void>
,Promise<java.lang.Void>
,java.util.concurrent.Future<java.lang.Void>
public class DefaultChannelPromise extends DefaultPromise<java.lang.Void> implements ChannelPromise
The defaultChannelPromise
implementation. It is recommended to useChannel.newPromise()
to create a newChannelPromise
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, EventExecutor executor)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
Returnstrue
if thisChannelFuture
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()
-
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 io.netty.util.concurrent.Promise
setUncancellable, tryFailure, trySuccess
-
-
-
-
Constructor Detail
-
DefaultChannelPromise
public DefaultChannelPromise(Channel channel)
Creates a new instance.- Parameters:
channel
- theChannel
associated with this future
-
DefaultChannelPromise
public DefaultChannelPromise(Channel channel, EventExecutor executor)
Creates a new instance.- Parameters:
channel
- theChannel
associated with this future
-
-
Method Detail
-
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 avoidStackOverflowError
by executing aRunnable
if the stack depth exceeds a threshold.- Overrides:
executor
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
channel
in interfaceChannelPromise
-
setSuccess
public ChannelPromise setSuccess()
- Specified by:
setSuccess
in interfaceChannelPromise
-
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 anIllegalStateException
.- Specified by:
setSuccess
in interfaceChannelPromise
- Specified by:
setSuccess
in interfacePromise<java.lang.Void>
- Overrides:
setSuccess
in classDefaultPromise<java.lang.Void>
-
trySuccess
public boolean trySuccess()
- Specified by:
trySuccess
in interfaceChannelPromise
-
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 anIllegalStateException
.- Specified by:
setFailure
in interfaceChannelPromise
- Specified by:
setFailure
in interfacePromise<java.lang.Void>
- Overrides:
setFailure
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
addListener
in interfaceChannelPromise
- Specified by:
addListener
in interfaceFuture<java.lang.Void>
- Specified by:
addListener
in interfacePromise<java.lang.Void>
- Overrides:
addListener
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
addListeners
in interfaceChannelPromise
- Specified by:
addListeners
in interfaceFuture<java.lang.Void>
- Specified by:
addListeners
in interfacePromise<java.lang.Void>
- Overrides:
addListeners
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
removeListener
in interfaceChannelPromise
- Specified by:
removeListener
in interfaceFuture<java.lang.Void>
- Specified by:
removeListener
in interfacePromise<java.lang.Void>
- Overrides:
removeListener
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
removeListeners
in interfaceChannelPromise
- Specified by:
removeListeners
in interfaceFuture<java.lang.Void>
- Specified by:
removeListeners
in interfacePromise<java.lang.Void>
- Overrides:
removeListeners
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
sync
in interfaceChannelPromise
- Specified by:
sync
in interfaceFuture<java.lang.Void>
- Specified by:
sync
in interfacePromise<java.lang.Void>
- Overrides:
sync
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
syncUninterruptibly
in interfaceChannelPromise
- Specified by:
syncUninterruptibly
in interfaceFuture<java.lang.Void>
- Specified by:
syncUninterruptibly
in interfacePromise<java.lang.Void>
- Overrides:
syncUninterruptibly
in classDefaultPromise<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 interfaceChannelFuture
- Specified by:
await
in interfaceChannelPromise
- Specified by:
await
in interfaceFuture<java.lang.Void>
- Specified by:
await
in interfacePromise<java.lang.Void>
- Overrides:
await
in classDefaultPromise<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 anInterruptedException
and discards it silently.- Specified by:
awaitUninterruptibly
in interfaceChannelFuture
- Specified by:
awaitUninterruptibly
in interfaceChannelPromise
- Specified by:
awaitUninterruptibly
in interfaceFuture<java.lang.Void>
- Specified by:
awaitUninterruptibly
in interfacePromise<java.lang.Void>
- Overrides:
awaitUninterruptibly
in classDefaultPromise<java.lang.Void>
-
flushCheckpoint
public long flushCheckpoint()
-
flushCheckpoint
public void flushCheckpoint(long checkpoint)
-
promise
public ChannelPromise promise()
-
checkDeadLock
protected void checkDeadLock()
- Overrides:
checkDeadLock
in classDefaultPromise<java.lang.Void>
-
unvoid
public ChannelPromise unvoid()
Description copied from interface:ChannelPromise
- Specified by:
unvoid
in interfaceChannelPromise
-
isVoid
public boolean isVoid()
Description copied from interface:ChannelFuture
Returnstrue
if thisChannelFuture
is a void future and so not allow to call any of the following methods:- Specified by:
isVoid
in interfaceChannelFuture
-
-