Struct tm_wheel::TimerDriverBase

pub struct TimerDriverBase<T, A: SlabAllocator<TimerNode<T>>, const LEVELS: usize, const WHEEL_SIZE: usize> { /* private fields */ }

Basic timer driver with manually configurable page size / slab allocator.

• WHEELS: Number of timing wheel hierarchy.
• WHEEL_LENGTH: Number of slots in each page. This MUST be power of 2.

Implementations

impl<T, A: SlabAllocator<TimerNode<T>>, const LEVELS: usize, const WHEEL_SIZE: usize> TimerDriverBase<T, A, LEVELS, WHEEL_SIZE>

pub const LEVELS: usize = LEVELS

pub fn new(slab: A) -> Self

pub fn insert(&mut self, value: T, expires_at: TimePoint) -> TimerHandle

Insert new timer with expiration time point.

Panics

• Specified timer expiration is out of range.
• Active timer instance is larger than 2^32-1

pub fn expiration_limit(&self) -> TimeOffset

Get the maximum amount of time that can be set for a timer. Returned value is offset time from the current time point.

pub fn remove(&mut self, handle: TimerHandle) -> Option<T>

Remove given timer handle from the driver.

pub fn len(&self) -> usize

Get the number of registered timers.

pub fn is_empty(&self) -> bool

Check if the driver is empty.

pub fn now(&self) -> TimePoint

Get the current time point.

pub fn reserve(&mut self, additional: usize)

Reserve the space for additional timers. If underlying SlabAllocator doesn’t support it, this method does nothing.

pub fn reset(&mut self, now: TimePoint)

Remove all timers. Time point regression is only allowed if the driver is empty.

pub fn nearest_wakeup(&mut self) -> Option<NonZeroU64>

Suggested timing for next wakeup. It is guaranteed that none of the timers will be overslept until returned time point.

If there’s no nearest timer in lowest level page, it’ll return the nearest rehash timing which will drag down the timers from higher pages, resulting no actual timer expiration output.

pub fn advance_to( &mut self, time_point: TimePoint ) -> TimerDriverDrainIter<'_, T, A, LEVELS, WHEEL_SIZE>

Advance timer driver to the given time point.

Warning

Expiration order is not guaranteed. It’s caller’s responsibility to handle correct expiration order.

Panics

Panics if the given time point is less than the current time point. Same time point doesn’t cause panic, as it’s meaningful for timer insertions that are already expired.

pub fn advance( &mut self, advance: TimeOffset ) -> TimerDriverDrainIter<'_, T, A, LEVELS, WHEEL_SIZE>

Advance timer by timer amount.

Trait Implementations

impl<T: Clone, A: Clone + SlabAllocator<TimerNode<T>>, const LEVELS: usize, const WHEEL_SIZE: usize> Clone for TimerDriverBase<T, A, LEVELS, WHEEL_SIZE>

fn clone(&self) -> TimerDriverBase<T, A, LEVELS, WHEEL_SIZE>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, A: Debug + SlabAllocator<TimerNode<T>>, const LEVELS: usize, const WHEEL_SIZE: usize> Debug for TimerDriverBase<T, A, LEVELS, WHEEL_SIZE>

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

Formats the value using the given formatter.

impl<T, A, const LEVELS: usize, const WHEEL_SIZE: usize> Default for TimerDriverBase<T, A, LEVELS, WHEEL_SIZE>

where A: SlabAllocator<TimerNode<T>> + Default,

fn default() -> Self

Returns the “default value” for a type.