Package io.netty.channel
Class VoidChannelPromise
- All Implemented Interfaces:
ChannelFuture
,ChannelPromise
,Future<Void>
,Promise<Void>
,Future<Void>
@UnstableApi
public final class VoidChannelPromise
extends AbstractFuture<Void>
implements ChannelPromise
-
Nested Class Summary
Nested classes/interfaces inherited from interface java.util.concurrent.Future
Future.State
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionVoidChannelPromise
(Channel channel, boolean fireException) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionaddListener
(GenericFutureListener<? extends Future<? super Void>> listener) Adds the specified listener to this future.addListeners
(GenericFutureListener<? extends Future<? super Void>>... listeners) Adds the specified listeners to this future.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
Waits for this future to be completed within the specified time limit.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, 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 aCancellationException
.cause()
Returns the cause of the failed I/O operation if the I/O operation has failed.channel()
Returns a channel where the I/O operation associated with this future takes place.private static void
fail()
private void
fireException0
(Throwable cause) getNow()
Return the result without blocking.boolean
returnstrue
if and only if the operation can be cancelled viaFuture.cancel(boolean)
.boolean
boolean
isDone()
boolean
Returnstrue
if and only if the I/O operation was completed successfully.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()
removeListener
(GenericFutureListener<? extends Future<? super Void>> listener) Removes the first occurrence of the specified listener from this future.removeListeners
(GenericFutureListener<? extends Future<? super Void>>... listeners) Removes the first occurrence for each of the listeners from this future.setFailure
(Throwable cause) Marks this future as a failure and notifies all listeners.setSuccess
(Void result) Marks this future as a success and notifies all listeners.boolean
Make this future impossible to cancel.sync()
Waits for this future until it is done, and rethrows the cause of the failure if this future failed.Waits for this future until it is done, and rethrows the cause of the failure if this future failed.boolean
tryFailure
(Throwable cause) Marks this future as a failure and notifies all listeners.boolean
boolean
trySuccess
(Void result) Marks this future as a success and notifies all listeners.unvoid()
Methods inherited from class io.netty.util.concurrent.AbstractFuture
get, get
-
Field Details
-
channel
-
fireExceptionListener
-
-
Constructor Details
-
VoidChannelPromise
Creates a new instance.- Parameters:
channel
- theChannel
associated with this future
-
-
Method Details
-
addListener
public VoidChannelPromise addListener(GenericFutureListener<? extends Future<? super 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<Void>
- Specified by:
addListener
in interfacePromise<Void>
-
addListeners
public VoidChannelPromise addListeners(GenericFutureListener<? extends Future<? super 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<Void>
- Specified by:
addListeners
in interfacePromise<Void>
-
removeListener
public VoidChannelPromise removeListener(GenericFutureListener<? extends Future<? super 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<Void>
- Specified by:
removeListener
in interfacePromise<Void>
-
removeListeners
public VoidChannelPromise removeListeners(GenericFutureListener<? extends Future<? super 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<Void>
- Specified by:
removeListeners
in interfacePromise<Void>
-
await
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<Void>
- Specified by:
await
in interfacePromise<Void>
- Throws:
InterruptedException
- if the current thread was interrupted
-
await
Description copied from interface:Future
Waits for this future to be completed within the specified time limit. -
await
public boolean await(long timeoutMillis) Description copied from interface:Future
Waits for this future to be completed within the specified time limit. -
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<Void>
- Specified by:
awaitUninterruptibly
in interfacePromise<Void>
-
awaitUninterruptibly
Description copied from interface:Future
Waits for this future to be completed within the specified time limit without interruption. This method catches anInterruptedException
and discards it silently.- Specified by:
awaitUninterruptibly
in interfaceFuture<Void>
- Returns:
true
if and only if the future was completed within the specified time limit
-
awaitUninterruptibly
public boolean awaitUninterruptibly(long timeoutMillis) Description copied from interface:Future
Waits for this future to be completed within the specified time limit without interruption. This method catches anInterruptedException
and discards it silently.- Specified by:
awaitUninterruptibly
in interfaceFuture<Void>
- Returns:
true
if and only if the future was completed within the specified time limit
-
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
-
isDone
public boolean isDone() -
isSuccess
public boolean isSuccess()Description copied from interface:Future
Returnstrue
if and only if the I/O operation was completed successfully. -
setUncancellable
public boolean setUncancellable()Description copied from interface:Promise
Make this future impossible to cancel.- Specified by:
setUncancellable
in interfacePromise<Void>
- Returns:
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.
-
isCancellable
public boolean isCancellable()Description copied from interface:Future
returnstrue
if and only if the operation can be cancelled viaFuture.cancel(boolean)
.- Specified by:
isCancellable
in interfaceFuture<Void>
-
isCancelled
public boolean isCancelled()- Specified by:
isCancelled
in interfaceFuture<Void>
-
cause
Description copied from interface:Future
Returns the cause of the failed I/O operation if the I/O operation has failed. -
sync
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<Void>
- Specified by:
sync
in interfacePromise<Void>
-
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<Void>
- Specified by:
syncUninterruptibly
in interfacePromise<Void>
-
setFailure
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<Void>
-
setSuccess
- Specified by:
setSuccess
in interfaceChannelPromise
-
tryFailure
Description copied from interface:Promise
Marks this future as a failure and notifies all listeners.- Specified by:
tryFailure
in interfacePromise<Void>
- Returns:
true
if and only if successfully marked this future as a failure. Otherwisefalse
because this future is already marked as either a success or a failure.
-
cancel
public boolean cancel(boolean mayInterruptIfRunning) If the cancellation was successful it will fail the future with aCancellationException
. -
trySuccess
public boolean trySuccess()- Specified by:
trySuccess
in interfaceChannelPromise
-
fail
private static void fail() -
setSuccess
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<Void>
-
trySuccess
Description copied from interface:Promise
Marks this future as a success and notifies all listeners.- Specified by:
trySuccess
in interfacePromise<Void>
- Returns:
true
if and only if successfully marked this future as a success. Otherwisefalse
because this future is already marked as either a success or a failure.
-
getNow
Description copied from interface:Future
Return the result without blocking. If the future is not done yet this will returnnull
. As it is possible that anull
value is used to mark the future as successful you also need to check if the future is really done withFuture.isDone()
and not rely on the returnednull
value. -
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
-
fireException0
-