Struct hierarchical_hash_wheel_timer::wheels::cancellable::QuadWheelWithOverflow

pub struct QuadWheelWithOverflow<EntryType> where
    EntryType: CancellableTimerEntry,  { /* fields omitted */ }

An implementation of four-level byte-sized wheel

Any value scheduled so far off that it doesn't fit into the wheel is stored in an overflow Vec and added to the wheel, once time as advanced enough that it actually fits. In this design the maximum schedule duration for the wheel itself is u32::MAX units (typically ms), everything else goes into the overflow Vec.

Methods

impl<EntryType> QuadWheelWithOverflow<EntryType> where
    EntryType: TimerEntryWithDelay + CancellableTimerEntry, 

pub fn insert(&mut self, e: EntryType) -> Result<(), TimerError<EntryType>>

Insert a new timeout into the wheel

pub fn insert_ref(
    &mut self,
    e: Rc<EntryType>
) -> Result<(), TimerError<Rc<EntryType>>>

Insert a new timeout into the wheel

impl<EntryType> QuadWheelWithOverflow<EntryType> where
    EntryType: CancellableTimerEntry, 

pub fn new() -> Self

Create a new wheel

pub fn insert_ref_with_delay(
    &mut self,
    e: Rc<EntryType>,
    delay: Duration
) -> Result<(), TimerError<Rc<EntryType>>>

Insert a new timeout into the wheel to be returned after delay ticks

pub fn cancel(
    &mut self,
    id: &EntryType::Id
) -> Result<(), TimerError<Infallible>>

Cancel the timeout with the given id

This method is very cheap, as it doesn't actually touch the wheels at all. It simply removes the value from the lookup table, so it can't be executed once its triggered. This also automatically prevents rescheduling of periodic timeouts.

pub fn tick(&mut self) -> Vec<Rc<EntryType>>

Move the wheel forward by a single unit (ms)

Returns a list of all timers that expire during this tick.

pub fn skip(&mut self, amount: u32)

Skip a certain amount of units (ms)

No timers will be executed for the skipped time. Only use this after determining that it's actually valid with can_skip!

pub fn can_skip(&self) -> Skip

Determine if and how many ticks can be skipped