Struct BreakerState 

pub struct BreakerState {
    unhealthy_count: u32,
    healthy_count: u32,
    trip_round: u32,
    open_until: Option<Instant>,
}

State of one circuit breaker (shared by an api-breaker check/observe pair).

Fields

unhealthy_count: u32

Consecutive unhealthy responses observed while closed.

healthy_count: u32

Consecutive healthy responses observed while half-open.

trip_round: u32

How many times the breaker has tripped in the current unhealthy spell, used to grow the cooldown.

open_until: Option<Instant>

When the breaker is open, the instant it may move to half-open.

Implementations

impl BreakerState

pub fn allow(&mut self) -> bool

Whether a request should be allowed through right now. When the open window has elapsed the breaker becomes half-open (this call returns true to let one probe through).

pub fn record_healthy(&mut self, healthy_threshold: u32)

Records a healthy upstream response. After healthy_threshold consecutive healthy responses the breaker fully closes.

pub fn record_unhealthy( &mut self, unhealthy_threshold: u32, break_base_sec: u64, max_breaker_sec: u64, )

Records an unhealthy upstream response. After unhealthy_threshold consecutive unhealthy responses the breaker opens for min(max_breaker_sec, break_base_sec * 2^trip_round).

Trait Implementations

impl Default for BreakerState

fn default() -> BreakerState

Returns the “default value” for a type.