com.aol.cyclops.data.async.wait

Interface WaitStrategy<T>

Type Parameters:

T - Data type of elements in Queue

All Known Implementing Classes:

DirectWaitStrategy, ExponentialBackofWaitStrategy, NoWaitRetry, SpinWait, YieldWait

public interface WaitStrategy<T>

An interface that defines a Waiting strategy to be employed when an async.Queue is full or empty

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WaitStrategy.Offerable Represents something that may recieve data
static interface	WaitStrategy.Takeable<T> Represents something that may provide data

Method Summary

Modifier and Type	Method and Description
static <T> DirectWaitStrategy<T>	direct()
static <T> ExponentialBackofWaitStrategy<T>	exponentialBackOff()
static <T> NoWaitRetry<T>	noWaitRetry()
boolean	offer(WaitStrategy.Offerable o) Push data into a recievable type using the provided offerable
static <T> SpinWait<T>	spinWait()
T	take(WaitStrategy.Takeable<T> t) Attempt to take from Takeable
static <T> YieldWait<T>	yieldWait()

Method Detail

take

T take(WaitStrategy.Takeable<T> t)
throws java.lang.InterruptedException

Attempt to take from Takeable

Parameters:

t - Takeable to take next data point from

Returns:

Data taken

Throws:

java.lang.InterruptedException

offer

boolean offer(WaitStrategy.Offerable o)
       throws java.lang.InterruptedException

Push data into a recievable type using the provided offerable

Parameters:

o - Offerable to push data to recievable type

Returns:

true if data pushed via Offerable

Throws:

java.lang.InterruptedException

yieldWait

static <T> YieldWait<T> yieldWait()

Returns:

YieldWait strategy YieldWait

spinWait

static <T> SpinWait<T> spinWait()

Returns:

SpinWait strategy SpinWait

noWaitRetry

static <T> NoWaitRetry<T> noWaitRetry()

Returns:

NoWaitRetry strategy NoWaitRetry

exponentialBackOff

static <T> ExponentialBackofWaitStrategy<T> exponentialBackOff()

Returns:

ExponentialBackofWaitStrategy ExponentialBackofWaitStrategy

direct

static <T> DirectWaitStrategy<T> direct()

Returns:

DirectWaitStrategy DirectWaitStrategy