org.apache.cassandra.utils.concurrent

Class SyncPromise<V>

java.lang.Object

org.apache.cassandra.utils.concurrent.AbstractFuture<V>

org.apache.cassandra.utils.concurrent.SyncFuture<V>

org.apache.cassandra.utils.concurrent.SyncPromise<V>

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<V>, io.netty.util.concurrent.Promise<V>, java.util.concurrent.Future<V>, Awaitable

Direct Known Subclasses:

SyncPromise.WithExecutor

public class SyncPromise<V>
extends SyncFuture<V>
implements Promise<V>

Extends SyncFuture to implement the Promise interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncPromise.WithExecutor<V>

Nested classes/interfaces inherited from interface org.apache.cassandra.utils.concurrent.Awaitable

Awaitable.AbstractAwaitable, Awaitable.AsyncAwaitable, Awaitable.Defaults, Awaitable.SyncAwaitable

Field Summary

Fields inherited from class org.apache.cassandra.utils.concurrent.AbstractFuture

CANCELLED, UNCANCELLABLE, UNSET

Constructor Summary

Constructors

Constructor and Description
SyncPromise()
SyncPromise(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)

Method Summary

Modifier and Type	Method and Description
SyncPromise<V>	addCallback(java.util.function.Consumer<? super V> onSuccess, java.util.function.Consumer<? super java.lang.Throwable> onFailure) Support more fluid version of Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.
SyncPromise<V>	addCallback(com.google.common.util.concurrent.FutureCallback<? super V> callback) Support Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) natively See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.
SyncPromise<V>	addCallback(com.google.common.util.concurrent.FutureCallback<? super V> callback, java.util.concurrent.Executor executor) Support Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) natively See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.
SyncPromise<V>	addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener) Add a listener to be invoked once this future completes.
SyncPromise<V>	addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>>... listeners)
SyncPromise<V>	await() Wait for this promise to complete
SyncPromise<V>	awaitThrowUncheckedOnInterrupt() Wait for this promise to complete, throwing any interrupt as an UncheckedInterruptedException
SyncPromise<V>	awaitUninterruptibly() Wait uninterruptibly for this promise to complete
boolean	isUncancellable()
SyncPromise<V>	removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)
SyncPromise<V>	removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>>... listeners)
Promise<V>	setFailure(java.lang.Throwable throwable) Complete the promise abnormally if not already complete
Promise<V>	setSuccess(V v) Complete the promise successfully if not already complete
boolean	setUncancellable() Prevent a future caller from cancelling this promise
boolean	setUncancellableExclusive() Prevent a future caller from cancelling this promise
Promise<V>	sync() waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces
Promise<V>	syncUninterruptibly() waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces
boolean	tryFailure(java.lang.Throwable throwable) Complete the promise abnormally if not already complete
boolean	trySuccess(V v) Complete the promise successfully if not already complete
static <V> SyncPromise<V>	uncancellable()
static <V> SyncPromise<V>	uncancellable(java.util.concurrent.Executor executor)
static <V> SyncPromise<V>	uncancellable(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)
static <V> SyncPromise<V>	withExecutor(java.util.concurrent.Executor executor)

Methods inherited from class org.apache.cassandra.utils.concurrent.SyncFuture

awaitUntil, flatMap, map

Methods inherited from class org.apache.cassandra.utils.concurrent.AbstractFuture

addCallback, addCallback, addCallback, addListener, addListener, await, awaitThrowUncheckedOnInterrupt, awaitUninterruptibly, awaitUntilThrowUncheckedOnInterrupt, awaitUntilUninterruptibly, cancel, cause, description, flatMap, get, get, getNow, getWhenDone, isCancellable, isCancelled, isDone, isSuccess, map, map, notifyExecutor, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cassandra.utils.concurrent.Promise

listener, listener

Methods inherited from interface org.apache.cassandra.utils.concurrent.Future

addCallback, addCallback, addCallback, addListener, addListener, await, awaitUninterruptibly, flatMap, flatMap, map, map, notifyExecutor, rethrowIfFailed, syncThrowUncheckedOnInterrupt

Methods inherited from interface io.netty.util.concurrent.Future

await, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future

get, get, isCancelled, isDone

Methods inherited from interface org.apache.cassandra.utils.concurrent.Awaitable

await, awaitThrowUncheckedOnInterrupt, awaitUninterruptibly, awaitUntil, awaitUntilThrowUncheckedOnInterrupt, awaitUntilUninterruptibly

Constructor Detail

SyncPromise

public SyncPromise()

SyncPromise

public SyncPromise(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)

Method Detail

withExecutor

public static <V> SyncPromise<V> withExecutor(java.util.concurrent.Executor executor)

uncancellable

public static <V> SyncPromise<V> uncancellable()

uncancellable

public static <V> SyncPromise<V> uncancellable(java.util.concurrent.Executor executor)

uncancellable

public static <V> SyncPromise<V> uncancellable(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)

setSuccess

public Promise<V> setSuccess(V v)

Complete the promise successfully if not already complete

Specified by:

setSuccess in interface io.netty.util.concurrent.Promise<V>

Throws:

java.lang.IllegalStateException - if already set

trySuccess

public boolean trySuccess(V v)

Complete the promise successfully if not already complete

Specified by:

trySuccess in interface io.netty.util.concurrent.Promise<V>

Overrides:

trySuccess in class AbstractFuture<V>

Returns:

true iff completed promise

setFailure

public Promise<V> setFailure(java.lang.Throwable throwable)

Complete the promise abnormally if not already complete

Specified by:

setFailure in interface io.netty.util.concurrent.Promise<V>

Throws:

java.lang.IllegalStateException - if already set

tryFailure

public boolean tryFailure(java.lang.Throwable throwable)

Complete the promise abnormally if not already complete

Specified by:

tryFailure in interface io.netty.util.concurrent.Promise<V>

Overrides:

tryFailure in class AbstractFuture<V>

Returns:

true iff completed promise

setUncancellable

public boolean setUncancellable()

Prevent a future caller from cancelling this promise

Specified by:

setUncancellable in interface io.netty.util.concurrent.Promise<V>

Overrides:

setUncancellable in class AbstractFuture<V>

Returns:

true if the promise is now uncancellable (whether or not we did this)

setUncancellableExclusive

public boolean setUncancellableExclusive()

Prevent a future caller from cancelling this promise

Overrides:

setUncancellableExclusive in class AbstractFuture<V>

Returns:

true iff this invocation set it to uncancellable, whether or not now uncancellable

isUncancellable

public boolean isUncancellable()

Overrides:

isUncancellable in class AbstractFuture<V>

sync

public Promise<V> sync()
                throws java.lang.InterruptedException

waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces

Specified by:

sync in interface io.netty.util.concurrent.Promise<V>

Throws:

java.lang.InterruptedException

syncUninterruptibly

public Promise<V> syncUninterruptibly()

waits for completion; in case of failure rethrows the original exception without a new wrapping exception so may cause problems for reporting stack traces

Specified by:

syncUninterruptibly in interface io.netty.util.concurrent.Promise<V>

addListener

public SyncPromise<V> addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)

Description copied from class: AbstractFuture

Add a listener to be invoked once this future completes. Listeners are submitted to AbstractFuture.notifyExecutor() in the order they are added (or the specified executor in the case of AbstractFuture.addListener(Runnable, Executor). if AbstractFuture.notifyExecutor() is unset, they are invoked in the order they are added. The ordering holds across all variants of this method.

Specified by:

addListener in interface io.netty.util.concurrent.Promise<V>

Overrides:

addListener in class AbstractFuture<V>

addListeners

public SyncPromise<V> addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>>... listeners)

Specified by:

addListeners in interface io.netty.util.concurrent.Promise<V>

Overrides:

addListeners in class AbstractFuture<V>

removeListener

public SyncPromise<V> removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>> listener)

Specified by:

removeListener in interface io.netty.util.concurrent.Promise<V>

Overrides:

removeListener in class AbstractFuture<V>

removeListeners

public SyncPromise<V> removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super V>>... listeners)

Specified by:

removeListeners in interface io.netty.util.concurrent.Promise<V>

Overrides:

removeListeners in class AbstractFuture<V>

addCallback

public SyncPromise<V> addCallback(com.google.common.util.concurrent.FutureCallback<? super V> callback)

Description copied from class: AbstractFuture

Support Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) natively See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.

Overrides:

addCallback in class AbstractFuture<V>

addCallback

public SyncPromise<V> addCallback(com.google.common.util.concurrent.FutureCallback<? super V> callback,
                                  java.util.concurrent.Executor executor)

Description copied from class: AbstractFuture

Support Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) natively See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.

Overrides:

addCallback in class AbstractFuture<V>

addCallback

public SyncPromise<V> addCallback(java.util.function.Consumer<? super V> onSuccess,
                                  java.util.function.Consumer<? super java.lang.Throwable> onFailure)

Description copied from class: AbstractFuture

Support more fluid version of Futures.addCallback(com.google.common.util.concurrent.ListenableFuture<V>, com.google.common.util.concurrent.FutureCallback<? super V>, java.util.concurrent.Executor) See AbstractFuture.addListener(GenericFutureListener) for ordering semantics.

Overrides:

addCallback in class AbstractFuture<V>

await

public SyncPromise<V> await()
                     throws java.lang.InterruptedException

Wait for this promise to complete

Specified by:

await in interface io.netty.util.concurrent.Promise<V>

Specified by:

await in interface Awaitable

Overrides:

await in class SyncFuture<V>

Throws:

java.lang.InterruptedException - if interrupted

awaitUninterruptibly

public SyncPromise<V> awaitUninterruptibly()

Wait uninterruptibly for this promise to complete

Specified by:

awaitUninterruptibly in interface io.netty.util.concurrent.Promise<V>

Specified by:

awaitUninterruptibly in interface Awaitable

Overrides:

awaitUninterruptibly in class AbstractFuture<V>

awaitThrowUncheckedOnInterrupt

public SyncPromise<V> awaitThrowUncheckedOnInterrupt()
                                              throws UncheckedInterruptedException

Wait for this promise to complete, throwing any interrupt as an UncheckedInterruptedException

Specified by:

awaitThrowUncheckedOnInterrupt in interface Awaitable

Overrides:

awaitThrowUncheckedOnInterrupt in class AbstractFuture<V>

Throws:

UncheckedInterruptedException - if interrupted