Struct capsules_core::virtualizers::virtual_alarm::VirtualMuxAlarm

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

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

Implementations

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

pub fn new(mux_alarm: &'a MuxAlarm<'a, A>) -> VirtualMuxAlarm<'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 alarms won’t fire

Trait Implementations

impl<'a, A: Alarm<'a>> Alarm<'a> for VirtualMuxAlarm<'a, A>

fn set_alarm_client(&self, client: &'a dyn AlarmClient)

Specify the callback for when the counter reaches the alarm value. If there was a previously installed callback this call replaces it.

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

Disable the alarm and stop it from firing in the future. Valid Result<(), ErrorCode> codes are:

fn is_armed(&self) -> bool

Returns whether the alarm is currently armed. Note that this does not reliably indicate whether there will be a future callback: it is possible that the alarm has triggered (and disarmed) and a callback is pending and has not been called yet. In this case it possible for is_armed to return false yet to receive a callback.

fn set_alarm(&self, reference: Self::Ticks, dt: Self::Ticks)

Specify when the callback should be called and enable it. The callback will be enqueued when Time::now() == reference + dt. The callback itself may not run exactly at this time, due to delays. However, it it assured to execute after reference + dt: it can be delayed but will never fire early. The method takes reference and dt rather than a single value denoting the counter value so it can distinguish between alarms which have very recently already passed and those in the far far future (see #1651).

fn get_alarm(&self) -> Self::Ticks

Return the current alarm value. This is undefined at boot and otherwise returns now + dt from the last call to set_alarm.

fn minimum_dt(&self) -> Self::Ticks

Return the minimum dt value that is supported. Any dt smaller than this will automatically be increased to this minimum value.

impl<'a, A: Alarm<'a>> AlarmClient for VirtualMuxAlarm<'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, VirtualMuxAlarm<'a, A>> for VirtualMuxAlarm<'a, A>

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

impl<'a, A: Alarm<'a>> Time for VirtualMuxAlarm<'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) -> Self::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.