net.uncontended.precipice.concurrent

Class SingleWriterResilientPromise<T>

java.lang.Object

net.uncontended.precipice.concurrent.AbstractResilientPromise<T>

net.uncontended.precipice.concurrent.SingleWriterResilientPromise<T>

Type Parameters:

T - the result returned by the action

All Implemented Interfaces:

ResilientPromise<T>

public class SingleWriterResilientPromise<T>
extends AbstractResilientPromise<T>

A class wrapping the result of an action. 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.

This class is designed to be written to by ONE thread only. It primarily exists to avoid expensive compareAndSet calls that are required in the multiple writer scenario. This promise is used in synchronous run) calls.

Field Summary

Fields inherited from class net.uncontended.precipice.concurrent.AbstractResilientPromise

result

Constructor Summary

Constructors

Constructor and Description
SingleWriterResilientPromise()

Method Summary

Modifier and Type	Method and Description
boolean	deliverError(java.lang.Exception error) Deliver an error to this promise.
boolean	deliverResult(T result) Deliver the result to this promise.
boolean	setTimedOut() Set the promise Status to timeout.

Methods inherited from class net.uncontended.precipice.concurrent.AbstractResilientPromise

await, await, awaitResult, getError, getResult, getStatus, isDone, isError, isSuccessful, isTimedOut, wrapPromise

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleWriterResilientPromise

public SingleWriterResilientPromise()

Method Detail

deliverResult

public boolean deliverResult(T result)

Description copied from interface: ResilientPromise

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

public boolean deliverError(java.lang.Exception error)

Description copied from interface: ResilientPromise

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

setTimedOut

public boolean setTimedOut()

Description copied from interface: ResilientPromise

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