net.uncontended.precipice

Interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

Type Parameters:

Rejected - the type for rejection reasons

All Known Subinterfaces:

CircuitBreaker<Rejected>

All Known Implementing Classes:

DefaultCircuitBreaker, LongSemaphore, NoOpCircuitBreaker, NoOpenCircuit, RateLimiter, RefactoredBreaker, SWCircuitBreaker, UnlimitedSemaphore

public interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

A mechanism to provide back pressure for task execution.

Method Summary

Modifier and Type	Method and Description
Rejected	acquirePermit(long number, long nanoTime) Acquires the request permits for task execution.
<Result extends java.lang.Enum<Result> & Failable> void	registerGuardRail(GuardRail<Result,Rejected> guardRail) This method will register a guard rail with this back pressure mechanism.
void	releasePermit(long number, Failable result, long nanoTime) Releases permits while considering the result of the execution.
void	releasePermit(long number, long nanoTime) Releases permits without considering the result of the execution.

Method Detail

acquirePermit

Rejected acquirePermit(long number,
                       long nanoTime)

Acquires the request permits for task execution. If the execution is denied due to back pressure, then a the rejected reason is returned. If the permits are successfully acquired, then null is returned.

Parameters:

number - of permits requested

nanoTime - currentInterval nanosecond time

Returns:

the reason for rejection if permit acquisition fails

releasePermit

void releasePermit(long number,
                   long nanoTime)

Releases permits without considering the result of the execution.

Parameters:

number - of permits to release

nanoTime - currentInterval nanosecond time

releasePermit

void releasePermit(long number,
                   Failable result,
                   long nanoTime)

Releases permits while considering the result of the execution. The result of the execution may help inform the logic of the back pressure mechanism (depending on the implementation).

Parameters:

number - of permits to release

result - of the task execution

nanoTime - currentInterval nanosecond time

registerGuardRail

<Result extends java.lang.Enum<Result> & Failable> void registerGuardRail(GuardRail<Result,Rejected> guardRail)

This method will register a guard rail with this back pressure mechanism. It is called when when constructing a guard rail. This allows back pressure decisions to be made based upon the object associated with guard rail.

Parameters:

guardRail - the guard rail registered