Struct TimeWheel

pub struct TimeWheel<T> { /* private fields */ }

A binary-heap based timing wheel implementation.

Implementations

impl<T> TimeWheel<T>

pub fn new(tick_interval: Duration) -> Self

Create a time-wheel with minimum time interval resolution tick_interval.

pub fn len(&self) -> usize

Returns the number of alive timers.

pub fn deadline(&mut self, deadline: Instant, value: T) -> Option<u64>

Create a new timer using provided deadline.

Return None if the deadline is already reach.

Examples

use std::time::{ Duration, Instant };
use timing_wheel::TimeWheel;
use std::thread::sleep;

let mut time_wheel = TimeWheel::new(Duration::from_millis(1));

time_wheel.deadline(Instant::now() + Duration::from_millis(1), ());

sleep(Duration::from_millis(2));

let mut wakers = vec![];

time_wheel.spin(&mut wakers);

assert_eq!(wakers.into_iter().map(|v| v.1).collect::<Vec<_>>(), vec![()]);

pub fn after(&mut self, duration: Duration, value: T) -> Option<u64>

Create a new deadline with a value equal to Instant::now() + duration.

Examples

use std::time::Duration;
use timing_wheel::TimeWheel;
use std::thread::sleep;

let mut time_wheel = TimeWheel::new(Duration::from_millis(1));

time_wheel.after(Duration::from_millis(1), ());

sleep(Duration::from_millis(2));

let mut wakers = vec![];

time_wheel.spin(&mut wakers);

assert_eq!(wakers.into_iter().map(|v| v.1).collect::<Vec<_>>(), vec![()]);

pub fn spin(&mut self, wakers: &mut Vec<(u64, T)>)

Spin the wheel according to the current time and detect(returns) the expiry timers.