com.alibaba.csp.sentinel.slots.block.degrade.circuitbreaker

Enum CircuitBreaker.State

java.lang.Object

java.lang.Enum<CircuitBreaker.State>

com.alibaba.csp.sentinel.slots.block.degrade.circuitbreaker.CircuitBreaker.State

All Implemented Interfaces:

Serializable, Comparable<CircuitBreaker.State>

Enclosing interface:

CircuitBreaker

public static enum CircuitBreaker.State
extends Enum<CircuitBreaker.State>

Circuit breaker state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED In CLOSED state, all requests are permitted.
HALF_OPEN In HALF_OPEN state, the circuit breaker will allow a "probe" invocation.
OPEN In OPEN state, all requests will be rejected until the next recovery time point.

Method Summary

Modifier and Type	Method and Description
static CircuitBreaker.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static CircuitBreaker.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPEN

public static final CircuitBreaker.State OPEN

In OPEN state, all requests will be rejected until the next recovery time point.

HALF_OPEN

public static final CircuitBreaker.State HALF_OPEN

In HALF_OPEN state, the circuit breaker will allow a "probe" invocation. If the invocation is abnormal according to the strategy (e.g. it's slow), the circuit breaker will re-transform to the OPEN state and wait for the next recovery time point; otherwise the resource will be regarded as "recovered" and the circuit breaker will cease cutting off requests and transform to CLOSED state.

CLOSED

public static final CircuitBreaker.State CLOSED

In CLOSED state, all requests are permitted. When current metric value exceeds the threshold, the circuit breaker will transform to OPEN state.

Method Detail

values

public static CircuitBreaker.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CircuitBreaker.State c : CircuitBreaker.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CircuitBreaker.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null