public class DefaultChannelProgressivePromise extends DefaultProgressivePromise<Void> implements ChannelProgressivePromise
ChannelProgressivePromise implementation. It is recommended to use
ChannelOutboundInvoker.newProgressivePromise() to create a new ChannelProgressivePromise rather than calling the
constructor explicitly.PROPERTY_MAX_LISTENER_STACK_DEPTH | Constructor and Description |
|---|
DefaultChannelProgressivePromise (Channel channel)
Creates a new instance.
|
DefaultChannelProgressivePromise (Channel channel,
EventExecutor executor)
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
ChannelProgressivePromise |
addListener (GenericFutureListener<? extends Future<? super Void>> listener)
Adds the specified listener to this future.
|
ChannelProgressivePromise |
addListeners (GenericFutureListener<? extends Future<? super Void>>... listeners)
Adds the specified listeners to this future.
|
ChannelProgressivePromise |
await ()
Waits for this future to be completed.
|
ChannelProgressivePromise |
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()
|
ChannelProgressivePromise |
promise () |
ChannelProgressivePromise |
removeListener (GenericFutureListener<? extends Future<? super Void>> listener)
Removes the first occurrence of the specified listener from this future.
|
ChannelProgressivePromise |
removeListeners (GenericFutureListener<? extends Future<? super Void>>... listeners)
Removes the first occurrence for each of the listeners from this future.
|
ChannelProgressivePromise |
setFailure (Throwable cause)
Marks this future as a failure and notifies all
listeners.
|
ChannelProgressivePromise |
setProgress (long progress,
long total)
Sets the current progress of the operation and notifies the listeners that implement
GenericProgressiveFutureListener. |
ChannelProgressivePromise |
setSuccess () |
ChannelProgressivePromise |
setSuccess (Void result)
Marks this future as a success and notifies all
listeners.
|
ChannelProgressivePromise |
sync ()
Waits for this future until it is done, and rethrows the cause of the failure if this future
failed.
|
ChannelProgressivePromise |
syncUninterruptibly ()
Waits for this future until it is done, and rethrows the cause of the failure if this future
failed.
|
boolean |
trySuccess () |
ChannelProgressivePromise |
unvoid ()
|
tryProgress await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait tryProgress setUncancellable, tryFailure, trySuccess await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess get, get, isCancelled, isDone public DefaultChannelProgressivePromise(Channel channel)
channel - the Channel associated with this futurepublic DefaultChannelProgressivePromise(Channel channel, EventExecutor executor)
channel - the Channel associated with this futureprotected EventExecutor executor()
DefaultPromise
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.
executor in class DefaultPromise<Void>public Channel channel()
ChannelFuture channel in interface ChannelFuture channel in interface ChannelPromise public ChannelProgressivePromise setSuccess()
setSuccess in interface ChannelProgressivePromise setSuccess in interface ChannelPromise public ChannelProgressivePromise setSuccess(Void result)
Promise IllegalStateException.setSuccess in interface ChannelProgressivePromise setSuccess in interface ChannelPromise setSuccess in interface ProgressivePromise<Void>setSuccess in interface Promise<Void>setSuccess in class DefaultProgressivePromise<Void>public boolean trySuccess()
trySuccess in interface ChannelPromise public ChannelProgressivePromise setFailure(Throwable cause)
Promise IllegalStateException.setFailure in interface ChannelProgressivePromise setFailure in interface ChannelPromise setFailure in interface ProgressivePromise<Void>setFailure in interface Promise<Void>setFailure in class DefaultProgressivePromise<Void>public ChannelProgressivePromise setProgress(long progress, long total)
ProgressivePromise GenericProgressiveFutureListener.setProgress in interface ChannelProgressivePromise setProgress in interface ProgressivePromise<Void>setProgress in class DefaultProgressivePromise<Void>public ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super Void>> listener)
Future addListener in interface ChannelFuture addListener in interface ChannelProgressiveFuture addListener in interface ChannelProgressivePromise addListener in interface ChannelPromise addListener in interface ProgressiveFuture<Void>addListener in interface ProgressivePromise<Void>addListener in interface Promise<Void>addListener in class DefaultProgressivePromise<Void>public ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)
Future addListeners in interface ChannelFuture addListeners in interface ChannelProgressiveFuture addListeners in interface ChannelProgressivePromise addListeners in interface ChannelPromise addListeners in interface ProgressiveFuture<Void>addListeners in interface ProgressivePromise<Void>addListeners in interface Promise<Void>addListeners in class DefaultProgressivePromise<Void>public ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener)
Future removeListener in interface ChannelFuture removeListener in interface ChannelProgressiveFuture removeListener in interface ChannelProgressivePromise removeListener in interface ChannelPromise removeListener in interface ProgressiveFuture<Void>removeListener in interface ProgressivePromise<Void>removeListener in interface Promise<Void>removeListener in class DefaultProgressivePromise<Void>public ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)
Future removeListeners in interface ChannelFuture removeListeners in interface ChannelProgressiveFuture removeListeners in interface ChannelProgressivePromise removeListeners in interface ChannelPromise removeListeners in interface ProgressiveFuture<Void>removeListeners in interface ProgressivePromise<Void>removeListeners in interface Promise<Void>removeListeners in class DefaultProgressivePromise<Void>public ChannelProgressivePromise sync() throws InterruptedException
Future sync in interface ChannelFuture sync in interface ChannelProgressiveFuture sync in interface ChannelProgressivePromise sync in interface ChannelPromise sync in interface ProgressiveFuture<Void>sync in interface ProgressivePromise<Void>sync in interface Promise<Void>sync in class DefaultProgressivePromise<Void>InterruptedException public ChannelProgressivePromise syncUninterruptibly()
Future syncUninterruptibly in interface ChannelFuture syncUninterruptibly in interface ChannelProgressiveFuture syncUninterruptibly in interface ChannelProgressivePromise syncUninterruptibly in interface ChannelPromise syncUninterruptibly in interface ProgressiveFuture<Void>syncUninterruptibly in interface ProgressivePromise<Void>syncUninterruptibly in interface Promise<Void>syncUninterruptibly in class DefaultProgressivePromise<Void>public ChannelProgressivePromise await() throws InterruptedException
Future await in interface ChannelFuture await in interface ChannelProgressiveFuture await in interface ChannelProgressivePromise await in interface ChannelPromise await in interface ProgressiveFuture<Void>await in interface ProgressivePromise<Void>await in interface Promise<Void>await in class DefaultProgressivePromise<Void>InterruptedException - if the current thread was interruptedpublic ChannelProgressivePromise awaitUninterruptibly()
Future InterruptedException and
discards it silently.awaitUninterruptibly in interface ChannelFuture awaitUninterruptibly in interface ChannelProgressiveFuture awaitUninterruptibly in interface ChannelProgressivePromise awaitUninterruptibly in interface ChannelPromise awaitUninterruptibly in interface ProgressiveFuture<Void>awaitUninterruptibly in interface ProgressivePromise<Void>awaitUninterruptibly in interface Promise<Void>awaitUninterruptibly in class DefaultProgressivePromise<Void>public long flushCheckpoint()
public void flushCheckpoint(long checkpoint)
public ChannelProgressivePromise promise()
protected void checkDeadLock()
checkDeadLock in class DefaultPromise<Void>public ChannelProgressivePromise unvoid()
ChannelPromise unvoid in interface ChannelProgressivePromise unvoid in interface ChannelPromise public boolean isVoid()
ChannelFuture true if this ChannelFuture is a void future and so not allow to call any of the
following methods:
isVoid in interface ChannelFuture Copyright © 2008–2025 The Netty Project. All rights reserved.