com.linecorp.armeria.client.circuitbreaker

Interface CircuitBreaker

public interface CircuitBreaker

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

Method Summary

Modifier and Type	Method and Description
boolean	canRequest() Decides whether a request should be sent or failed depending on the current circuit state.
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	onFailure(Throwable cause) Reports a remote invocation failure with the reason.
void	onSuccess() Reports a remote invocation success.

Method Detail

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(Throwable cause)

Reports a remote invocation failure with the reason.

Parameters:

cause - The cause of failure.

onFailure

void onFailure()

Reports a remote invocation failure.

canRequest

boolean canRequest()

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