io.lettuce.core.failover

Interface CircuitBreaker

All Superinterfaces:

AutoCloseable, Closeable

@Experimental
public interface CircuitBreaker
extends Closeable

Circuit breaker for tracking command metrics and managing circuit breaker state.

This interface provides methods to track command metrics and manage circuit breaker state. Implementations must be thread-safe.

Since:

7.4

Author:

Ali Takavci

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CircuitBreaker.State

Method Summary

Modifier and Type	Method and Description
void	addListener(CircuitBreakerStateListener listener) Add a listener for circuit breaker state change events.
void	close()
CircuitBreaker.State	getCurrentState() Get the current state of the circuit breaker.
io.lettuce.core.failover.CircuitBreakerGeneration	getGeneration() Get the current generation of the circuit breaker.
String	getId() Get the ID for this circuit breaker.
MetricsSnapshot	getSnapshot() Get a snapshot of the current metrics within the time window.
boolean	isClosed() Check if the circuit breaker is in the closed state.
void	removeListener(CircuitBreakerStateListener listener) Remove a listener for circuit breaker state change events.
void	transitionTo(CircuitBreaker.State newState) Transition the circuit breaker to the specified state.

Method Detail

getId

String getId()

Get the ID for this circuit breaker.

Returns:

the ID

getSnapshot

MetricsSnapshot getSnapshot()

Get a snapshot of the current metrics within the time window. Use the snapshot to access success count, failure count, total count, and failure rate.

Returns:

an immutable snapshot of current metrics

getGeneration

io.lettuce.core.failover.CircuitBreakerGeneration getGeneration()

Get the current generation of the circuit breaker. This is used to track the state and metrics of the circuit breaker at the time of command execution.

Returns:

the current generation of the circuit breaker

getCurrentState

CircuitBreaker.State getCurrentState()

Get the current state of the circuit breaker.

Returns:

the current state

isClosed

boolean isClosed()

Check if the circuit breaker is in the closed state.

Returns:

true if the circuit breaker is in the closed state

transitionTo

void transitionTo(CircuitBreaker.State newState)

Transition the circuit breaker to the specified state. This method is used to force the circuit breaker to a specific state.

Parameters:

newState - the target state

addListener

void addListener(CircuitBreakerStateListener listener)

Add a listener for circuit breaker state change events.

Parameters:

listener - the listener to add, must not be null

removeListener

void removeListener(CircuitBreakerStateListener listener)

Remove a listener for circuit breaker state change events.

Parameters:

listener - the listener to remove, must not be null

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable