org.tikv.service.failsafe

Class CircuitBreakerImpl

java.lang.Object

org.tikv.service.failsafe.CircuitBreakerImpl

All Implemented Interfaces:

Closeable, AutoCloseable, CircuitBreaker

public class CircuitBreakerImpl
extends Object
implements CircuitBreaker

Nested Class Summary

Nested classes/interfaces inherited from interface org.tikv.service.failsafe.CircuitBreaker

CircuitBreaker.Status

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerImpl(boolean enable, int windowInSeconds, int errorThresholdPercentage, int requestVolumeThreshold, int sleepWindowInSeconds, int attemptRequestCount, long clusterId)
CircuitBreakerImpl(TiConfiguration conf, long clusterId)

Method Summary

Modifier and Type	Method and Description
boolean	allowRequest() Every requests asks this if it is allowed to proceed or not.
boolean	attemptExecution() Invoked at start of command execution to attempt an execution.
void	close()
CircuitBreakerMetrics	getMetrics() Get the Circuit Breaker Metrics Object.
void	recordAttemptFailure() Invoked on unsuccessful executions as part of feedback mechanism when in a half-open state.
void	recordAttemptSuccess() Invoked on successful executions as part of feedback mechanism when in a half-open state.

Methods inherited from class java.lang.Object

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

Constructor Detail

CircuitBreakerImpl

public CircuitBreakerImpl(TiConfiguration conf,
                          long clusterId)

CircuitBreakerImpl

public CircuitBreakerImpl(boolean enable,
                          int windowInSeconds,
                          int errorThresholdPercentage,
                          int requestVolumeThreshold,
                          int sleepWindowInSeconds,
                          int attemptRequestCount,
                          long clusterId)

Method Detail

getMetrics

public CircuitBreakerMetrics getMetrics()

Description copied from interface: CircuitBreaker

Get the Circuit Breaker Metrics Object.

Specified by:

getMetrics in interface CircuitBreaker

allowRequest

public boolean allowRequest()

Description copied from interface: CircuitBreaker

Every requests asks this if it is allowed to proceed or not. It is idempotent and does not modify any internal state.

Specified by:

allowRequest in interface CircuitBreaker

Returns:

boolean whether a request should be permitted

recordAttemptSuccess

public void recordAttemptSuccess()

Description copied from interface: CircuitBreaker

Invoked on successful executions as part of feedback mechanism when in a half-open state.

Specified by:

recordAttemptSuccess in interface CircuitBreaker

recordAttemptFailure

public void recordAttemptFailure()

Description copied from interface: CircuitBreaker

Invoked on unsuccessful executions as part of feedback mechanism when in a half-open state.

Specified by:

recordAttemptFailure in interface CircuitBreaker

attemptExecution

public boolean attemptExecution()

Description copied from interface: CircuitBreaker

Invoked at start of command execution to attempt an execution. This is non-idempotent - it may modify internal state.

Specified by:

attemptExecution in interface CircuitBreaker

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException