net.uncontended.precipice.rate

Class RateLimiter<Rejected extends java.lang.Enum<Rejected>>

java.lang.Object

net.uncontended.precipice.rate.RateLimiter<Rejected>

All Implemented Interfaces:

BackPressure<Rejected>

public class RateLimiter<Rejected extends java.lang.Enum<Rejected>>
extends java.lang.Object
implements BackPressure<Rejected>

Unstable and still in development.

Constructor Summary

Constructors

Constructor and Description
RateLimiter(Rejected rejectedReason, long allowedPerPeriod, long duration, java.util.concurrent.TimeUnit timeUnit)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiter

public RateLimiter(Rejected rejectedReason,
                   long allowedPerPeriod,
                   long duration,
                   java.util.concurrent.TimeUnit timeUnit)

Method Detail

acquirePermit

public Rejected acquirePermit(long number,
                              long nanoTime)

Description copied from interface: BackPressure

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.

Specified by:

acquirePermit in interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

Parameters:

number - of permits requested

nanoTime - currentInterval nanosecond time

Returns:

the reason for rejection if permit acquisition fails

releasePermit

public void releasePermit(long number,
                          long nanoTime)

Description copied from interface: BackPressure

Releases permits without considering the result of the execution.

Specified by:

releasePermit in interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

Parameters:

number - of permits to release

nanoTime - currentInterval nanosecond time

releasePermit

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

Description copied from interface: BackPressure

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).

Specified by:

releasePermit in interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

Parameters:

number - of permits to release

result - of the task execution

nanoTime - currentInterval nanosecond time

registerGuardRail

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

Description copied from interface: BackPressure

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.

Specified by:

registerGuardRail in interface BackPressure<Rejected extends java.lang.Enum<Rejected>>

Parameters:

guardRail - the guard rail registered