Package io.netty.util.concurrent
Interface Promise<V>
-
- All Superinterfaces:
Future<V>,java.util.concurrent.Future<V>
- All Known Subinterfaces:
ChannelProgressivePromise,ChannelPromise,ProgressivePromise<V>
- All Known Implementing Classes:
DefaultChannelProgressivePromise,DefaultChannelPromise,DefaultProgressivePromise,DefaultPromise,DelegatingChannelPromiseNotifier,VoidChannelPromise
public interface Promise<V> extends Future<V>
SpecialFuturewhich is writable.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Promise<V>addListener(GenericFutureListener<? extends Future<? super V>> listener)Adds the specified listener to this future.Promise<V>addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)Adds the specified listeners to this future.Promise<V>await()Waits for this future to be completed.Promise<V>awaitUninterruptibly()Waits for this future to be completed without interruption.Promise<V>removeListener(GenericFutureListener<? extends Future<? super V>> listener)Removes the first occurrence of the specified listener from this future.Promise<V>removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)Removes the first occurrence for each of the listeners from this future.Promise<V>setFailure(java.lang.Throwable cause)Marks this future as a failure and notifies all listeners.Promise<V>setSuccess(V result)Marks this future as a success and notifies all listeners.booleansetUncancellable()Make this future impossible to cancel.Promise<V>sync()Waits for this future until it is done, and rethrows the cause of the failure if this future failed.Promise<V>syncUninterruptibly()Waits for this future until it is done, and rethrows the cause of the failure if this future failed.booleantryFailure(java.lang.Throwable cause)Marks this future as a failure and notifies all listeners.booleantrySuccess(V result)Marks this future as a success and notifies all listeners.-
Methods inherited from interface io.netty.util.concurrent.Future
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess
-
-
-
-
Method Detail
-
setSuccess
Promise<V> setSuccess(V result)
Marks this future as a success and notifies all listeners. If it is success or failed already it will throw anIllegalStateException.
-
trySuccess
boolean trySuccess(V result)
Marks this future as a success and notifies all listeners.- Returns:
trueif and only if successfully marked this future as a success. Otherwisefalsebecause this future is already marked as either a success or a failure.
-
setFailure
Promise<V> setFailure(java.lang.Throwable cause)
Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw anIllegalStateException.
-
tryFailure
boolean tryFailure(java.lang.Throwable cause)
Marks this future as a failure and notifies all listeners.- Returns:
trueif and only if successfully marked this future as a failure. Otherwisefalsebecause this future is already marked as either a success or a failure.
-
setUncancellable
boolean setUncancellable()
Make this future impossible to cancel.- Returns:
trueif and only if successfully marked this future as uncancellable or it is already done without being cancelled.falseif this future has been cancelled already.
-
addListener
Promise<V> addListener(GenericFutureListener<? extends Future<? super V>> listener)
Description copied from interface:FutureAdds 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:
addListenerin interfaceFuture<V>
-
addListeners
Promise<V> addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
Description copied from interface:FutureAdds 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:
addListenersin interfaceFuture<V>
-
removeListener
Promise<V> removeListener(GenericFutureListener<? extends Future<? super V>> listener)
Description copied from interface:FutureRemoves 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:
removeListenerin interfaceFuture<V>
-
removeListeners
Promise<V> removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
Description copied from interface:FutureRemoves 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:
removeListenersin interfaceFuture<V>
-
await
Promise<V> await() throws java.lang.InterruptedException
Description copied from interface:FutureWaits for this future to be completed.
-
awaitUninterruptibly
Promise<V> awaitUninterruptibly()
Description copied from interface:FutureWaits for this future to be completed without interruption. This method catches anInterruptedExceptionand discards it silently.- Specified by:
awaitUninterruptiblyin interfaceFuture<V>
-
sync
Promise<V> sync() throws java.lang.InterruptedException
Description copied from interface:FutureWaits for this future until it is done, and rethrows the cause of the failure if this future failed.
-
-