Resilience4j 2.3.0 · io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine

Modifier and Type	Class and Description
private class	CircuitBreakerStateMachine.CircuitBreakerEventProcessor
private static interface	CircuitBreakerStateMachine.CircuitBreakerState
private class	CircuitBreakerStateMachine.ClosedState
private class	CircuitBreakerStateMachine.DisabledState
private class	CircuitBreakerStateMachine.ForcedOpenState
private class	CircuitBreakerStateMachine.HalfOpenState
private class	CircuitBreakerStateMachine.MetricsOnlyState
private class	CircuitBreakerStateMachine.OpenState

Modifier and Type	Field and Description
private final CircuitBreakerConfig	circuitBreakerConfig
private final Clock	clock
private final Function<Clock, Long>	currentTimestampFunction
private final CircuitBreakerStateMachine.CircuitBreakerEventProcessor	eventProcessor
private final ReentrantLock	lock
private static final Logger	LOG
private final String	name
private final SchedulerFactory	schedulerFactory
private final AtomicReference<CircuitBreakerStateMachine.CircuitBreakerState>	stateReference
private final Map<String, String>	tags
private final TimeUnit	timestampUnit

Access	Constructor and Description
private	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, CircuitBreakerConfig The CircuitBreaker configuration. circuitBreakerConfig, SchedulerFactory A SchedulerFactory which can be mocked in tests. schedulerFactory, Map<String, String> tags) Creates a circuitBreaker.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, CircuitBreakerConfig The CircuitBreaker configuration. circuitBreakerConfig, SchedulerFactory A SchedulerFactory which can be mocked in tests. schedulerFactory) Creates a circuitBreaker.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, CircuitBreakerConfig The CircuitBreaker configuration. circuitBreakerConfig) Creates a circuitBreaker.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, CircuitBreakerConfig The CircuitBreaker configuration. circuitBreakerConfig, Map<String, String> tags) Creates a circuitBreaker.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name) Creates a circuitBreaker with default config.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, Supplier<CircuitBreakerConfig> The CircuitBreaker configuration supplier. circuitBreakerConfig) Creates a circuitBreaker.
public	CircuitBreakerStateMachine(String the name of the CircuitBreaker name, Supplier<CircuitBreakerConfig> The CircuitBreaker configuration supplier. circuitBreakerConfig, Map<String, String> tags) Creates a circuitBreaker.

Method Summary

Modifier and Type	Method and Description
public void	acquirePermission() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.acquirePermission. Try to obtain a permission to execute a call.
private Duration	elapsedDuration(final long duration, TimeUnit durationUnit)
public CircuitBreakerConfig	Returns: the config of this CircuitBreaker getCircuitBreakerConfig() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getCircuitBreakerConfig. Get the config of this CircuitBreaker.
public long	getCurrentTimestamp() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getCurrentTimestamp. Returns the current time with respect to the CircuitBreaker currentTimeFunction.
public CircuitBreaker.EventPublisher	getEventPublisher() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getEventPublisher. Returns an EventPublisher which can be used to register event consumers.
public CircuitBreaker.Metrics	getMetrics() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getMetrics. Returns the Metrics of this CircuitBreaker.
public String	Returns: the name of this CircuitBreaker getName() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getName. Get the name of this CircuitBreaker.
public CircuitBreaker.State	Returns: the state of this CircuitBreaker getState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getState. Get the state of this CircuitBreaker.
public Map<String, String>	getTags() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getTags. Returns an unmodifiable map with tags assigned to this CircuitBreaker.
public TimeUnit	getTimestampUnit() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.getTimestampUnit. Returns the timeUnit of current timestamp.
private void	handlePossibleTransition(Either<Object, Throwable> result)
private void	handleThrowable(long duration, TimeUnit durationUnit, Throwable throwable)
public void	onError(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit, Throwable The throwable which must be recorded throwable) Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.onError. Records a failed call.
public void	onResult(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit, Object The result of the protected function result) Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.onResult. This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not.
public void	onSuccess(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit) Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.onSuccess. Records a successful call.
private void	publishCallNotPermittedEvent()
private void	publishCircuitErrorEvent(final String name, final long duration, final TimeUnit durationUnit, final Throwable throwable)
private void	publishCircuitFailureRateExceededEvent(final String name, float failureRate)
private void	publishCircuitIgnoredErrorEvent(final String name, long duration, final TimeUnit durationUnit, final Throwable throwable)
private void	publishCircuitSlowCallRateExceededEvent(final String name, float slowCallRate)
private void	publishCircuitThresholdsExceededEvent(final CircuitBreakerMetrics.Result result, final CircuitBreakerMetrics metrics)
private void	publishEvent(CircuitBreakerEvent event)
private void	publishEventIfHasConsumer(CircuitBreakerEvent event)
private void	publishResetEvent()
private void	publishStateTransitionEvent(final CircuitBreaker.StateTransition stateTransition)
private void	publishSuccessEvent(final long duration, TimeUnit durationUnit)
public void	releasePermission() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.releasePermission. Releases a permission.
public void	reset() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.reset. Returns the circuit breaker to its original closed state, losing statistics.
private boolean	shouldPublishEvents(CircuitBreakerEvent event)
private void	stateTransition(CircuitBreaker.State newState, UnaryOperator<CircuitBreakerStateMachine.CircuitBreakerState> newStateGenerator)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	transitionToClosedState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToClosedState. Transitions the state machine to CLOSED state.
public void	transitionToDisabledState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToDisabledState. Transitions the state machine to a DISABLED state, stopping state transition, metrics and event publishing.
public void	transitionToForcedOpenState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToForcedOpenState. Transitions the state machine to a FORCED_OPEN state, stopping state transition, metrics and event publishing.
public void	transitionToHalfOpenState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToHalfOpenState. Transitions the state machine to HALF_OPEN state.
public void	transitionToMetricsOnlyState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToMetricsOnlyState. Transitions the state machine to METRICS_ONLY state, stopping all state transitions but continues to capture metrics and publish events.
public void	transitionToOpenState() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToOpenState. Transitions the state machine to OPEN state.
public void	transitionToOpenStateFor(Duration how long should we wait in open state waitDuration) Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToOpenStateFor. Same as `transitionToOpenState()` but waits in open state for the given amount of time instead of relaying on configurations to determine it.
public void	transitionToOpenStateUntil(Instant how long should we wait in open state waitUntil) Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.transitionToOpenStateUntil. Same as `transitionToOpenState()` but waits in open state until the given in time instead of relaying on configurations to determine it.
public boolean	tryAcquirePermission() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.tryAcquirePermission. Acquires a permission to execute a call, only if one is available at the time of invocation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public final Class CircuitBreakerStateMachine

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary