react

Class RPromise<T>

java.lang.Object

react.Reactor

react.RFuture<T>

react.RPromise<T>

public class RPromise<T>
extends RFuture<T>

Provides a concrete implementation RFuture that can be updated with a success or failure result when it becomes available.

This implementation also guarantees a useful behavior, which is that all listeners added prior to the completion of the promise will be cleared when the promise is completed, and no further listeners will be retained. This allows the promise to be retained after is has been completed as a useful "box" for its underlying value, without concern that references to long satisfied listeners will be inadvertently retained.

Nested Class Summary

Nested classes/interfaces inherited from class react.RFuture

RFuture.T2<A,B>, RFuture.T3<A,B,C>

Nested classes/interfaces inherited from class react.Reactor

Reactor.RListener

Constructor Summary

Constructors

Constructor and Description
RPromise()

Method Summary

Modifier and Type	Method and Description
void	complete(Try<T> result) Causes this promise to be completed with result.
Slot<Try<T>>	completer() Returns a slot that can be used to complete this promise.
static <T> RPromise<T>	create() Creates a new, uncompleted, promise.
void	fail(Throwable cause) Causes this promise to be completed with failure caused by cause.
Slot<Throwable>	failer() Returns a slot that can be used to fail(java.lang.Throwable) this promise.
Try<T>	result() Returns the result of this future, or null if it is not yet complete.
void	succeed(T value) Causes this promise to be completed successfully with value.
Slot<T>	succeeder() Returns a slot that can be used to succeed(T) this promise.

Methods inherited from class react.RFuture

bindComplete, collect, failure, flatMap, isComplete, isCompleteNow, map, onComplete, onFailure, onSuccess, recover, result, sequence, sequence, sequence, success, success, transform

Methods inherited from class react.Reactor

clearConnections, hasConnections

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RPromise

public RPromise()

Method Detail

create

public static <T> RPromise<T> create()

Creates a new, uncompleted, promise.

complete

public void complete(Try<T> result)

Causes this promise to be completed with result.

succeed

public void succeed(T value)

Causes this promise to be completed successfully with value.

fail

public void fail(Throwable cause)

Causes this promise to be completed with failure caused by cause.

completer

public Slot<Try<T>> completer()

Returns a slot that can be used to complete this promise.

succeeder

public Slot<T> succeeder()

Returns a slot that can be used to succeed(T) this promise.

failer

public Slot<Throwable> failer()

Returns a slot that can be used to fail(java.lang.Throwable) this promise.

result

public Try<T> result()

Description copied from class: RFuture

Returns the result of this future, or null if it is not yet complete.

NOTE: don't use this method! You should wire up reactions to the completion of this future via RFuture.onSuccess(react.SignalView.Listener<? super T>) or RFuture.onFailure(react.SignalView.Listener<? super java.lang.Throwable>). React is not a blocking async library where on might block a calling thread on the result of a future and then obtain the result synchronously. This is only appropriate when you're trying to abstract over synchronous and asynchronous variants of a computation, and you want to use the future machinery in both cases, but in the synchronous case you know that your future will be complete by the time you want to obtain its result.

Specified by:

result in class RFuture<T>