Package com.linecorp.armeria.client.circuitbreaker

Interface CircuitBreaker

public interface CircuitBreaker

A circuit breaker, which tracks the number of success/failure requests and detects a remote service failure.

Method Summary

Modifier and Type	Method	Description
static CircuitBreakerBuilder	builder()	Returns a new CircuitBreakerBuilder.
static CircuitBreakerBuilder	builder(String name)	Returns a new CircuitBreakerBuilder that has the specified name.
boolean	canRequest()	Deprecated. Use tryRequest().
CircuitState	circuitState()	Returns the current CircuitState.
void	enterState(CircuitState circuitState)	Enters the specified CircuitState.
String	name()	Returns the name of the circuit breaker.
static CircuitBreaker	of(String name)	Creates a new CircuitBreaker that has the specified name and the default configurations.
static CircuitBreaker	ofDefaultName()	Creates a new CircuitBreaker that has a default name and the default configurations.
void	onFailure()	Reports a remote invocation failure.
void	onSuccess()	Reports a remote invocation success.
default boolean	tryRequest()	Decides whether a request should be sent or failed depending on the current circuit state.

Method Details

builder

static CircuitBreakerBuilder builder()

Returns a new CircuitBreakerBuilder.

builder

static CircuitBreakerBuilder builder(String name)

Returns a new CircuitBreakerBuilder that has the specified name.

Parameters:

name - the name of the circuit breaker.

of

static CircuitBreaker of(String name)

Creates a new CircuitBreaker that has the specified name and the default configurations.

Parameters:

name - the name of the circuit breaker

ofDefaultName

static CircuitBreaker ofDefaultName()

Creates a new CircuitBreaker that has a default name and the default configurations.

name

String name()

Returns the name of the circuit breaker.

onSuccess

void onSuccess()

Reports a remote invocation success.

onFailure

void onFailure()

Reports a remote invocation failure.

canRequest

@Deprecated
boolean canRequest()

Deprecated.

Use tryRequest().

Decides whether a request should be sent or failed depending on the current circuit state.

tryRequest

default boolean tryRequest()

Decides whether a request should be sent or failed depending on the current circuit state. If the current state is CircuitState.OPEN and CircuitBreakerBuilder.circuitOpenWindow(Duration) has passed, the state will enter CircuitState.HALF_OPEN.

circuitState

CircuitState circuitState()

Returns the current CircuitState.

enterState

void enterState(CircuitState circuitState)

Enters the specified CircuitState. Note that even if the CircuitBreaker is already in the specified CircuitState, the internal state will be reinitialized. For instance, calling this method with CircuitState.OPEN will always reset the timeout to CircuitBreakerBuilder.circuitOpenWindow(Duration).

This method should be only used if users want extra control over the CircuitBreaker's state. Normally state transitions are handled internally.