Skip to main content

TimerService

Struct TimerService 

Source
pub struct TimerService { /* private fields */ }
Expand description

Timer service for scheduling and managing timers.

The timer service maintains a priority queue of timer registrations, ordered by timestamp. Operators can register timers to be fired at specific event times.

§Example

use laminar_core::time::{TimerService, TimerKey};

let mut service = TimerService::new();

// Register timers at different times
let id1 = service.register_timer(100, None, None);
let id2 = service.register_timer(50, Some(TimerKey::from_slice(&[1, 2, 3])), None);

// Poll for timers that should fire at time 75
let fired = service.poll_timers(75);
assert_eq!(fired.len(), 1);
assert_eq!(fired[0].id, id2); // Timer at t=50 fires first

Implementations§

Source§

impl TimerService

Source

pub fn new() -> Self

Creates a new timer service.

Source

pub fn register_timer( &mut self, timestamp: i64, key: Option<TimerKey>, operator_index: Option<usize>, ) -> u64

Registers a new timer.

Returns the unique timer ID that can be used to cancel the timer.

§Arguments
  • timestamp - The event time at which the timer should fire
  • key - Optional key for keyed operators
  • operator_index - Optional index of the operator registering the timer(must match the index in the reactor)
Source

pub fn poll_timers(&mut self, current_time: i64) -> FiredTimersVec

Polls for timers that should fire at or before the given timestamp.

Returns all timers with timestamps <= current_time, in order. Uses FiredTimersVec (SmallVec) to avoid heap allocation when few timers fire.

§Panics

This function should not panic under normal circumstances. The internal expect is only called after verifying the heap is not empty via peek.

Source

pub fn cancel_timer(&mut self, id: u64) -> bool

Cancels a timer by ID.

Returns true if the timer was found and cancelled.

Source

pub fn pending_count(&self) -> usize

Returns the number of pending timers.

Source

pub fn next_timer_timestamp(&self) -> Option<i64>

Returns the timestamp of the next timer to fire, if any.

Source

pub fn clear(&mut self)

Clears all pending timers.

Trait Implementations§

Source§

impl Default for TimerService

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,