Struct netstack3_base::LocalTimerHeap

pub struct LocalTimerHeap<K, V, BT: TimerBindingsTypes + InstantBindingsTypes> { /* private fields */ }

A local timer heap that keeps timers for core modules.

LocalTimerHeap manages its wakeups through a TimerContext.

K is the key that timers are keyed on. V is optional sidecar data to be kept with each timer.

Note that to provide fast timer deletion, LocalTimerHeap requires K to be Clone and the implementation assumes that the clone is cheap.

Implementations

impl<K, V, BC> LocalTimerHeap<K, V, BC>

where K: Hash + Eq + Clone + Debug, V: Debug + Eq + PartialEq, BC: TimerContext,

pub fn assert_timers( &self, timers: impl IntoIterator<Item = (K, V, BC::Instant)> )

Asserts installed timers with an iterator of (key, value, instant) tuples.

pub fn assert_timers_after( &self, bindings_ctx: &mut BC, timers: impl IntoIterator<Item = (K, V, Duration)> )

Like LocalTimerHeap::assert_timers, but asserts based on a duration after bindings_ctx.now().

pub fn assert_top(&mut self, key: &K, value: &V)

Assets that the next time to fire has key and value.

pub fn assert_range<'a, R: RangeBounds<BC::Instant> + Debug, I: IntoIterator<Item = (&'a K, R)>>( &'a self, expect: I )

Asserts that the given timer is installed with an instant at the provided range.

impl<K, V, BC> LocalTimerHeap<K, V, BC>

where K: Hash + Eq + Clone, BC: TimerContext,

pub fn new(bindings_ctx: &mut BC, dispatch_id: BC::DispatchId) -> Self

Creates a new LocalTimerHeap with wakeup dispatch ID dispatch_id.

pub fn new_with_context<D, CC: CoreTimerContext<D, BC>>( bindings_ctx: &mut BC, dispatch_id: D ) -> Self

Like [new] but uses CC to covert the dispatch_id to match the type required by BC.

pub fn schedule_instant( &mut self, bindings_ctx: &mut BC, timer: K, value: V, at: BC::Instant ) -> Option<(BC::Instant, V)>

Schedules timer with value at or after at.

If timer was already scheduled, returns the previously scheduled instant and the associated value.

pub fn schedule_after( &mut self, bindings_ctx: &mut BC, timer: K, value: V, after: Duration ) -> Option<(BC::Instant, V)>

Like [schedule_instant] but does the instant math from current time.

Panics

Panics if the current BC::Instant cannot be represented by adding duration after.

pub fn pop(&mut self, bindings_ctx: &mut BC) -> Option<(K, V)>

Pops an expired timer from the heap, if any.

pub fn get(&self, timer: &K) -> Option<(BC::Instant, &V)>

Returns the scheduled instant and associated value for timer, if it’s scheduled.

pub fn cancel( &mut self, bindings_ctx: &mut BC, timer: &K ) -> Option<(BC::Instant, V)>

Cancels timer, returning the scheduled instant and associated value if any.

pub fn iter(&self) -> impl Iterator<Item = (&K, &V, &BC::Instant)>

Gets an iterator over the installed timers.

Trait Implementations

impl<K: Debug, V: Debug, BT: Debug + TimerBindingsTypes + InstantBindingsTypes> Debug for LocalTimerHeap<K, V, BT>

where BT::Timer: Debug, BT::Instant: Debug,

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

Formats the value using the given formatter.