shared/com.santimattius.resilient.circuitbreaker/CircuitState

CircuitState

enum CircuitState : Enum<CircuitState>

Represents the three states of the circuit breaker.

CLOSED: Normal operation. Requests are allowed and executed.
OPEN: The breaker has tripped. Requests are rejected immediately without execution.
HALF_OPEN: A trial period after being open. A limited number of requests are allowed to test if the underlying issue is resolved.

Entries

CLOSED

OPEN

HALF_OPEN

Properties

entries

val entries: EnumEntries<CircuitState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): CircuitState

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.)

values

fun values(): Array<CircuitState>

Returns an array containing the constants of this enum type, in the order they're declared.