Struct Timer

pub struct Timer { /* private fields */ }

Manages timers and triggers timeouts.

Implementations

impl Timer

pub fn new() -> Self

Create a new timer containing no timeouts.

pub fn count(&self) -> usize

Return the number of timeouts being tracked.

pub fn has_timeouts(&self) -> bool

Check whether there are timeouts being tracked.

pub fn set_timeout(&mut self, timeout: Duration, after: Timestamp)

Register a new timeout relative to a certain point in time.

pub fn next_expiring_from(&self, time: impl Into<Timestamp>) -> Option<Duration>

Get the first timeout expiring right at or after certain moment of time. Returns None if there are no timeouts.

use reactor::{Timer, Timestamp};

let mut tm = Timer::new();

let now = Timestamp::now();
tm.set_timeout(Duration::from_secs(16), now);
tm.set_timeout(Duration::from_secs(8), now);
tm.set_timeout(Duration::from_secs(64), now);

let mut now = Timestamp::now();
// We need to wait 8 secs to trigger the next timeout (1).
assert!(tm.next_expiring_from(now) <= Some(Duration::from_secs(8)));

// ... sleep for a sec ...
now += Duration::from_secs(1);

// Now we don't need to wait as long!
assert!(tm.next_expiring_from(now).unwrap() <= Duration::from_secs(7));

pub fn remove_expired_by(&mut self, time: Timestamp) -> usize

Removes timeouts which expire by a certain moment of time (inclusive), returning total number of timeouts which were removed.

Trait Implementations

impl Debug for Timer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.