net.uncontended.precipice.concurrent

Interface ResilientPromise<T>

Type Parameters:

T - the result returned by the action

All Known Implementing Classes:

AbstractResilientPromise, DefaultResilientPromise, SingleWriterResilientPromise

public interface ResilientPromise<T>

A class wrapping the result of an action that will be completed at some point in the future. It is similar to ResilientFuture. However, unlike a future, a promise can be written to. A promise can only completed once. Once it is completed, all further attempts to update the status should fail.

Method Summary

Modifier and Type	Method and Description
void	await() Block on this promise being completed.
boolean	await(long timePeriod, java.util.concurrent.TimeUnit unit)
T	awaitResult() Block on this promise being completed and return the result.
boolean	deliverError(java.lang.Exception error) Deliver an error to this promise.
boolean	deliverResult(T result) Deliver the result to this promise.
java.lang.Exception	getError() Return any error that has been delivered.
T	getResult() Return any result that has been delivered.
Status	getStatus() Return the status of the promise.
boolean	isDone() Indicate if the Status of the promise is not pending.
boolean	isError() Indicate if the Status of the promise is error.
boolean	isSuccessful() Indicate if the Status of the promise is successful.
boolean	isTimedOut() Indicate if the Status of the promise is timeout.
boolean	setTimedOut() Set the promise Status to timeout.

Method Detail

deliverResult

boolean deliverResult(T result)

Deliver the result to this promise. If the promise has already been completed, this method will return false.

Parameters:

result - the result of the promise

Returns:

a boolean indicating if the result was successfully delivered

deliverError

boolean deliverError(java.lang.Exception error)

Deliver an error to this promise. If the promise has already been completed, this method will return false.

Parameters:

error - the error to deliver

Returns:

a boolean indicating if the error was successfully delivered

await

void await()
    throws java.lang.InterruptedException

Block on this promise being completed.

Throws:

java.lang.InterruptedException

await

boolean await(long timePeriod,
              java.util.concurrent.TimeUnit unit)
       throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

awaitResult

T awaitResult()
       throws java.lang.InterruptedException

Block on this promise being completed and return the result. If promise is not successfully completed, this will return null.

Returns:

T the result of the promise

Throws:

java.lang.InterruptedException

getResult

T getResult()

Return any result that has been delivered. If promise is not successfully completed or is still pending, this will return null.

Returns:

T the result of the promise

getError

java.lang.Exception getError()

Return any error that has been delivered. If action did not error or is still pending, this will return null.

Returns:

Exception the error of the promise

getStatus

Status getStatus()

Return the status of the promise.

Returns:

Status the status of the promise

setTimedOut

boolean setTimedOut()

Set the promise Status to timeout. If the promise has already been completed, this method will return false.

Returns:

a boolean indicating if the status was successfully set to timeout

isSuccessful

boolean isSuccessful()

Indicate if the Status of the promise is successful.

Returns:

boolean indicating if the status is successful

isDone

boolean isDone()

Indicate if the Status of the promise is not pending.

Returns:

boolean indicating if the promise is not pending

isError

boolean isError()

Indicate if the Status of the promise is error.

Returns:

boolean indicating if the status is error

isTimedOut

boolean isTimedOut()

Indicate if the Status of the promise is timeout.

Returns:

boolean indicating if the status is timeout