Struct capsules_core::virtualizers::virtual_timer::VirtualTimer

pub struct VirtualTimer<'a, A: Alarm<'a>> { /* private fields */ }

An object to multiplex multiple “virtual” timers over a single underlying alarm. A VirtualTimer is a node in a linked list of timers that share the same underlying alarm.

Implementations

impl<'a, A: Alarm<'a>> VirtualTimer<'a, A>

pub fn new(mux_timer: &'a MuxTimer<'a, A>) -> VirtualTimer<'a, A>

After calling new, always call setup()

pub fn setup(&'a self)

Call this method immediately after new() to link this to the mux, otherwise timers won’t fire

Trait Implementations

impl<'a, A: Alarm<'a>> AlarmClient for VirtualTimer<'a, A>

fn alarm(&self)

Callback indicating the alarm time has been reached. The alarm MUST be disabled when this is called. If a new alarm is needed, the client can call Alarm::set_alarm.

impl<'a, A: Alarm<'a>> ListNode<'a, VirtualTimer<'a, A>> for VirtualTimer<'a, A>

fn next(&self) -> &'a ListLink<'_, VirtualTimer<'a, A>>

impl<'a, A: Alarm<'a>> Time for VirtualTimer<'a, A>

type Frequency = <A as Time>::Frequency

The number of ticks per second

type Ticks = <A as Time>::Ticks

The width of a time value

fn now(&self) -> A::Ticks

Returns a timestamp. Depending on the implementation of Time, this could represent either a static timestamp or a sample of a counter; if an implementation relies on it being constant or changing it should use Timestamp or Counter.

impl<'a, A: Alarm<'a>> Timer<'a> for VirtualTimer<'a, A>

fn set_timer_client(&self, client: &'a dyn TimerClient)

Specify the callback to invoke when the timer interval expires. If there was a previously installed callback this call replaces it.

fn cancel(&self) -> Result<(), ErrorCode>

Cancel the current timer, if any. Value Result<(), ErrorCode> values are:

fn interval(&self) -> Option<Self::Ticks>

Return the interval of the last requested timer.

fn is_oneshot(&self) -> bool

Return if the last requested timer is a one-shot timer.

fn is_repeating(&self) -> bool

Return if the last requested timer is a repeating timer.

fn is_enabled(&self) -> bool

Returns whether there is currently a timer enabled and so a callback will be expected in the future. If is_enabled returns false then the implementation MUST NOT invoke a callback until a call to oneshot or repeating restarts the timer.

fn oneshot(&self, interval: Self::Ticks) -> Self::Ticks

Start a one-shot timer that will invoke the callback at least interval ticks in the future. If there is a timer currently pending, calling this cancels that previous timer. After a callback is invoked for a one shot timer, the timer MUST NOT invoke the callback again unless a new timer is started (either with repeating or one shot). Returns the actual interval for the timer that was registered. This MUST NOT be smaller than interval but MAY be larger.

fn repeating(&self, interval: Self::Ticks) -> Self::Ticks

Start a repeating timer that will invoke the callback every interval ticks in the future. If there is a timer currently pending, calling this cancels that previous timer. Returns the actual interval for the timer that was registered. This MUST NOT be smaller than interval but MAY be larger.

fn time_remaining(&self) -> Option<Self::Ticks>

Return how many ticks are remaining until the next callback, or None if the timer is disabled. This call is useful because there may be non-negligible delays between when a timer was requested and it was actually scheduled. Therefore, since a timer’s start might be delayed slightly, the time remaining might be slightly higher than one would expect if one calculated it right before the call to start the timer.