net.uncontended.precipice

Class GuardRail<Result extends java.lang.Enum<Result> & Failable,Rejected extends java.lang.Enum<Rejected>>

java.lang.Object

net.uncontended.precipice.GuardRail<Result,Rejected>

public class GuardRail<Result extends java.lang.Enum<Result> & Failable,Rejected extends java.lang.Enum<Rejected>>
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Rejected	acquirePermits(long number) Acquire permits for task execution.
Rejected	acquirePermits(long number, long nanoTime) Acquire permits for task execution.
static <Result extends java.lang.Enum<Result> & Failable,Rejected extends java.lang.Enum<Rejected>> GuardRail<Result,Rejected>	create(GuardRailProperties<Result,Rejected> properties)
java.util.Map<java.lang.String,BackPressure<Rejected>>	getBackPressure() Return the backpressure map used by the GuardRail.
Clock	getClock() Return the clock the GuardRail will refer to for time.
java.lang.String	getName() Return the name of the GuardRail.
WritableCounts<Rejected>	getRejectedCounts() Return the rejected counts fort the GuardRail.
WritableCounts<Result>	getResultCounts() Return the result counts for the GuardRail.
WritableLatency<Result>	getResultLatency() Return the result latency for the GuardRail.
PrecipiceFunction<Result,ExecutionContext>	releaseFunction() Return a function that, when called with a result and execution context, will release acquired permits.
void	releasePermits(ExecutionContext context, Result result) Release acquired permits with known result.
void	releasePermits(ExecutionContext context, Result result, long nanoTime) Release acquired permits with known result.
void	releasePermits(long number, Result result, long startNanos) Release acquired permits with known result.
void	releasePermits(long number, Result result, long startNanos, long nanoTime) Release acquired permits with known result.
void	releasePermitsWithoutResult(long number) Release acquired permits without result.
void	releasePermitsWithoutResult(long number, long nanoTime) Release acquired permits without result.

Methods inherited from class java.lang.Object

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

Method Detail

acquirePermits

public Rejected acquirePermits(long number)

Acquire permits for task execution. If the acquisition is rejected then a reason will be returned. If the acquisition is successful, null will be returned.

Parameters:

number - of permits to acquire

Returns:

the rejected reason

acquirePermits

public Rejected acquirePermits(long number,
                               long nanoTime)

Acquire permits for task execution. If the acquisition is rejected then a reason will be returned. If the acquisition is successful, null will be returned.

Parameters:

number - of permits to acquire

nanoTime - currentInterval nano time

Returns:

the rejected reason

releasePermitsWithoutResult

public void releasePermitsWithoutResult(long number)

Release acquired permits without result. Since there is not a known result the result count object and latency will not be updated.

Parameters:

number - of permits to release

releasePermitsWithoutResult

public void releasePermitsWithoutResult(long number,
                                        long nanoTime)

Release acquired permits without result. Since there is not a known result the result count object and latency will not be updated.

Parameters:

number - of permits to release

nanoTime - currentInterval nano time

releasePermits

public void releasePermits(ExecutionContext context,
                           Result result)

Release acquired permits with known result. Since there is a known result the result count object and latency will be updated.

Parameters:

context - context of the task execution

result - of the execution

releasePermits

public void releasePermits(ExecutionContext context,
                           Result result,
                           long nanoTime)

Release acquired permits with known result. Since there is a known result the result count object and latency will be updated.

Parameters:

context - context of the task execution

result - of the execution

nanoTime - currentInterval nano time

releasePermits

public void releasePermits(long number,
                           Result result,
                           long startNanos)

Release acquired permits with known result. Since there is a known result the result count object and latency will be updated.

Parameters:

number - of permits to release

result - of the execution

startNanos - of the execution

releasePermits

public void releasePermits(long number,
                           Result result,
                           long startNanos,
                           long nanoTime)

Release acquired permits with known result. Since there is a known result the result count object and latency will be updated.

Parameters:

number - of permits to release

result - of the execution

startNanos - of the execution

nanoTime - currentInterval nano time

releaseFunction

public PrecipiceFunction<Result,ExecutionContext> releaseFunction()

Return a function that, when called with a result and execution context, will release acquired permits.

Returns:

the function

getName

public java.lang.String getName()

Return the name of the GuardRail.

Returns:

the name

getResultCounts

public WritableCounts<Result> getResultCounts()

Return the result counts for the GuardRail.

Returns:

the result counts

getRejectedCounts

public WritableCounts<Rejected> getRejectedCounts()

Return the rejected counts fort the GuardRail.

Returns:

the rejected counts

getResultLatency

public WritableLatency<Result> getResultLatency()

Return the result latency for the GuardRail.

Returns:

the result latency

getBackPressure

public java.util.Map<java.lang.String,BackPressure<Rejected>> getBackPressure()

Return the backpressure map used by the GuardRail.

Returns:

the backpressure map

getClock

public Clock getClock()

Return the clock the GuardRail will refer to for time.

Returns:

the clock

create

public static <Result extends java.lang.Enum<Result> & Failable,Rejected extends java.lang.Enum<Rejected>> GuardRail<Result,Rejected> create(GuardRailProperties<Result,Rejected> properties)