Struct phron_finality::sync::ticker::Ticker

pub struct Ticker {
    last_reset: Instant,
    mode: Mode,
    max_timeout: Duration,
    min_timeout: Duration,
}

This struct is used for rate limiting as an on-demand ticker. It can be used for ticking at most after max_timeout but no sooner than after min_timeout. Example usage would be to use the wait method in main select loop and try_tick whenever you would like to tick sooner in another branch of select, resetting whenever the rate limited action actually occurs.

Fields

last_reset: Instant

mode: Mode

max_timeout: Duration

min_timeout: Duration

Implementations

impl Ticker

pub fn new(max_timeout: Duration, min_timeout: Duration) -> Self

Returns new Ticker struct. Enforces max_timeout >= min_timeout.

pub fn try_tick(&mut self) -> bool

Returns whether at least min_timeout time elapsed since the last reset. If it has not, the next call to wait_and_tick will return when min_timeout elapses.

pub async fn wait_and_tick(&mut self) -> bool

Sleeps until next tick should happen. Returns when enough time elapsed. Returns whether max_timeout elapsed since the last reset, and if so also resets.

Cancel safety

This method is cancellation safe.

pub fn reset(&mut self)

Reset the ticker, making it time from the moment of this call. Behaves as if it was just created with the same parametres.

fn since_reset(&self) -> Duration

async fn wait_current_timeout(&self)