Module io.helidon.faulttolerance

Package io.helidon.faulttolerance

Interface CircuitBreakerConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<CircuitBreaker>

All Known Implementing Classes:

CircuitBreakerConfig.BuilderBase.CircuitBreakerConfigImpl

public interface CircuitBreakerConfig
extends Prototype.Api

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CircuitBreakerConfig.Builder	Fluent API builder for CircuitBreaker.
static class	CircuitBreakerConfig.BuilderBase<BUILDER extends CircuitBreakerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CircuitBreakerConfig>	Fluent API builder base for CircuitBreaker.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ERROR_RATIO
static final int	DEFAULT_SUCCESS_THRESHOLD
static final int	DEFAULT_VOLUME

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends Throwable>>	applyOn()	These throwables will be considered failures.
static CircuitBreakerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static CircuitBreakerConfig.Builder	builder(CircuitBreakerConfig instance)	Create a new fluent API builder from an existing instance.
static CircuitBreakerConfig	create()	Create a new instance with default values.
static CircuitBreakerConfig	create(Config config)	Create a new instance from configuration.
Duration	delay()	How long to wait before transitioning from open to half-open state.
int	errorRatio()	How many failures out of 100 will trigger the circuit to open.
Optional<ExecutorService>	executor()	Executor service to schedule future tasks.
Optional<String>	name()
Set<Class<? extends Throwable>>	skipOn()	These throwables will not be considered failures, all other will.
int	successThreshold()	How many successful calls will close a half-open circuit.
int	volume()	Rolling window size used to calculate ratio of failed requests.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Field Details

DEFAULT_ERROR_RATIO

static final int DEFAULT_ERROR_RATIO

See Also:

• Constant Field Values

DEFAULT_SUCCESS_THRESHOLD

static final int DEFAULT_SUCCESS_THRESHOLD

See Also:

• Constant Field Values

DEFAULT_VOLUME

static final int DEFAULT_VOLUME

See Also:

• Constant Field Values

Method Details

builder

static CircuitBreakerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static CircuitBreakerConfig.Builder builder(CircuitBreakerConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static CircuitBreakerConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static CircuitBreakerConfig create()

Create a new instance with default values.

Returns:

a new instance

name

Optional<String> name()

delay

Duration delay()

How long to wait before transitioning from open to half-open state.

Returns:

delay

errorRatio

int errorRatio()

How many failures out of 100 will trigger the circuit to open. This is adapted to the volume() used to handle the window of requests.

If errorRatio is 40, and volume is 10, 4 failed requests will open the circuit. Default is 60.

Returns:

percent of failure that trigger the circuit to open

See Also:

• volume()

volume

int volume()

Rolling window size used to calculate ratio of failed requests. Default is 10.

Returns:

how big a window is used to calculate error errorRatio

See Also:

• errorRatio()

successThreshold

int successThreshold()

How many successful calls will close a half-open circuit. Nevertheless, the first failed call will open the circuit again. Default is 1.

Returns:

number of calls

executor

Optional<ExecutorService> executor()

Executor service to schedule future tasks.

Returns:

executor to use

skipOn

Set<Class<? extends Throwable>> skipOn()

These throwables will not be considered failures, all other will.

Returns:

throwable classes to not be considered a failure

See Also:

• applyOn()

applyOn

Set<Class<? extends Throwable>> applyOn()

These throwables will be considered failures.

Returns:

throwable classes to be considered a failure

See Also:

• skipOn()