Skip to content

Reference

phil/circuit-breaker
TypeKindRole
Phil\CircuitBreaker\CircuitKeyfinal readonly classWhat one breaker guards: of(), equals(), MAX_LENGTH
Phil\CircuitBreaker\CircuitPolicyfinal readonly classWhen a circuit opens and how it recovers: of(), trips()
Phil\CircuitBreaker\CircuitStateenumclosed, open, half_open
Phil\CircuitBreaker\CircuitSnapshotfinal readonly classThe state at one instant and its pure transitions: closed(), restore(), at(), record(), recordSuccess(), recordFailure(), permitsCalls()
Phil\CircuitBreaker\CircuitBreakerfinal readonly classOne breaker: isAvailable(), state(), record(), recordSuccess(), recordFailure()
Phil\CircuitBreaker\CallOutcomefinal readonly classHow one call went: succeeded() or failed(), with its duration in milliseconds when it was measured
Phil\CircuitBreaker\CircuitBreakersfinal readonly classThe breakers of an application by key: get(), has(), keys()
Phil\CircuitBreaker\CircuitOverridesfinal readonly classSeveral overrides asked together; none forcing anything when empty
Phil\CircuitBreaker\Contract\CircuitStateStoreinterfaceWhere the states live: load(), save()
Phil\CircuitBreaker\Contract\CircuitOverrideinterfaceWhether an operator forced a circuit open: isForcedOpen()
Phil\CircuitBreaker\Exception\CircuitBreakerExceptioninterfaceEvery exception of the library
Phil\CircuitBreaker\Exception\InvalidCircuitfinal classA key, a policy or a registry the library cannot work with
Phil\CircuitBreaker\Exception\UnknownCircuitfinal classA breaker asked for an undeclared key