com.tencentcloudapi.common

Class CircuitBreaker

java.lang.Object

com.tencentcloudapi.common.CircuitBreaker

public class CircuitBreaker
extends Object

A circuit breaker implementation that protects against system failures by temporarily blocking requests after a threshold of failures is reached.

This class uses a state machine with three states: Closed, HalfOpen, and Open.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircuitBreaker.Setting Settings class for the circuit breaker that defines its behavior.
static class	CircuitBreaker.Token A token returned by the circuit breaker to indicate whether a request is allowed.

Constructor Summary

Constructors

Constructor and Description
CircuitBreaker() Default constructor that uses the default settings.
CircuitBreaker(CircuitBreaker.Setting setting) Constructor that allows specifying custom settings.

Method Summary

Modifier and Type	Method and Description
CircuitBreaker.Token	allow() Attempt to allow a request based on the current state of the circuit breaker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CircuitBreaker

public CircuitBreaker()

Default constructor that uses the default settings.

CircuitBreaker

public CircuitBreaker(CircuitBreaker.Setting setting)

Constructor that allows specifying custom settings.

Parameters:

setting - The settings to use for the circuit breaker.

Method Detail

allow

public CircuitBreaker.Token allow()

Attempt to allow a request based on the current state of the circuit breaker.

Returns:

A Token that indicates whether the request is allowed or not.