org.tikv.service.failsafe

Interface CircuitBreaker

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CircuitBreakerImpl

public interface CircuitBreaker
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CircuitBreaker.Status

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.
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 interface java.io.Closeable

close

Method Detail

allowRequest

boolean allowRequest()

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

Returns:

boolean whether a request should be permitted

attemptExecution

boolean attemptExecution()

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

recordAttemptSuccess

void recordAttemptSuccess()

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

recordAttemptFailure

void recordAttemptFailure()

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

getMetrics

CircuitBreakerMetrics getMetrics()

Get the Circuit Breaker Metrics Object.