Struct LiveTimer

pub struct LiveTimer {
    pub name: Ustr,
    pub interval_ns: NonZeroU64,
    pub start_time_ns: UnixNanos,
    pub stop_time_ns: Option<UnixNanos>,
    /* private fields */
}

A live timer for use with a LiveClock.

LiveTimer triggers events at specified intervals in a real-time environment, using Tokio’s async runtime to handle scheduling and execution.

Fields

name: Ustr

The name of the timer.

interval_ns: NonZeroU64

The start time of the timer in UNIX nanoseconds.

start_time_ns: UnixNanos

The start time of the timer in UNIX nanoseconds.

stop_time_ns: Option<UnixNanos>

The optional stop time of the timer in UNIX nanoseconds.

Implementations

impl LiveTimer

pub fn new( name: &str, interval_ns: u64, start_time_ns: UnixNanos, stop_time_ns: Option<UnixNanos>, callback: TimeEventCallback, heap: Arc<Mutex<BinaryHeap<TimeEvent>>>, ) -> Self

Creates a new LiveTimer instance.

Panics

This function panics:

• If name is not a valid string.
• If interval_ns is zero.

pub fn next_time_ns(&self) -> UnixNanos

Returns the next time in UNIX nanoseconds when the timer will fire.

Provides the scheduled time for the next event based on the current state of the timer.

pub fn is_expired(&self) -> bool

Returns whether the timer is expired.

An expired timer will not trigger any further events. A timer that has not been started is not expired.

pub fn start(&mut self)

Starts the timer.

Time events will begin triggering at the specified intervals. The generated events are handled by the provided callback function.

pub fn cancel(&mut self)

Cancels the timer.

The timer will not generate a final event.