net.uncontended.precipice.circuit.experimental

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

java.lang.Object

net.uncontended.precipice.circuit.experimental.AbstractBreaker

net.uncontended.precipice.circuit.experimental.RefactoredBreaker<Rejected>

All Implemented Interfaces:

BackPressure<Rejected>, CircuitBreaker<Rejected>

public class RefactoredBreaker<Rejected extends java.lang.Enum<Rejected>>
extends AbstractBreaker
implements CircuitBreaker<Rejected>

Field Summary

Fields inherited from class net.uncontended.precipice.circuit.experimental.AbstractBreaker

CLOSED, FORCED_OPEN, OPEN, state

Constructor Summary

Constructors

Constructor and Description
RefactoredBreaker(Rejected reason, Rejected forcedReason, HealthChecker checker, long backOffTimeNanos)

Method Summary

Modifier and Type	Method and Description
Rejected	acquirePermit(long number, long nanoTime) Acquires the request permits for task execution.
CircuitBreakerConfig<Rejected>	getBreakerConfig()
<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.
void	setBreakerConfig(CircuitBreakerConfig<Rejected> breakerConfig)

Methods inherited from class net.uncontended.precipice.circuit.experimental.AbstractBreaker

forceClosed, forceOpen, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.uncontended.precipice.circuit.CircuitBreaker

forceClosed, forceOpen, isOpen

Constructor Detail

RefactoredBreaker

public RefactoredBreaker(Rejected reason,
                         Rejected forcedReason,
                         HealthChecker checker,
                         long backOffTimeNanos)

Method Detail

getBreakerConfig

public CircuitBreakerConfig<Rejected> getBreakerConfig()

Specified by:

getBreakerConfig in interface CircuitBreaker<Rejected extends java.lang.Enum<Rejected>>

setBreakerConfig

public void setBreakerConfig(CircuitBreakerConfig<Rejected> breakerConfig)

Specified by:

setBreakerConfig in interface CircuitBreaker<Rejected extends java.lang.Enum<Rejected>>

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