com.alibaba.csp.sentinel.slots.block.degrade.circuitbreaker

Interface CircuitBreaker

All Known Implementing Classes:

AbstractCircuitBreaker, ExceptionCircuitBreaker, ResponseTimeCircuitBreaker

public interface CircuitBreaker

Basic circuit breaker interface.

Author:

Eric Zhao

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CircuitBreaker.State Circuit breaker state.

Method Summary

Modifier and Type	Method and Description
CircuitBreaker.State	currentState() Get current state of the circuit breaker.
DegradeRule	getRule() Get the associated circuit breaking rule.
void	onRequestComplete(Context context) Record a completed request with the context and handle state transformation of the circuit breaker.
boolean	tryPass(Context context) Acquires permission of an invocation only if it is available at the time of invoking.

Method Detail

getRule

DegradeRule getRule()

Get the associated circuit breaking rule.

Returns:

associated circuit breaking rule

tryPass

boolean tryPass(Context context)

Acquires permission of an invocation only if it is available at the time of invoking.

Parameters:

context - context of current invocation

Returns:

true if permission was acquired and false otherwise

currentState

CircuitBreaker.State currentState()

Get current state of the circuit breaker.

Returns:

current state of the circuit breaker

onRequestComplete

void onRequestComplete(Context context)

Record a completed request with the context and handle state transformation of the circuit breaker.

Called when a passed invocation finished.

Parameters:

context - context of current invocation