Struct kernel::VirtualSchedulerTimer

pub struct VirtualSchedulerTimer<A: 'static + Alarm<'static>> { /* fields omitted */ }

Implementation of SchedulerTimer trait on top of a virtual alarm.

Currently, this implementation depends slightly on the virtual alarm implementation in capsules -- namely it assumes that get_alarm will still return the passed value even after the timer is disarmed. Thus this should only be implemented with a virtual alarm. If a dedicated hardware timer is available, it is more performant to implement the scheduler timer directly for that hardware peripheral without the alarm abstraction in between.

This mostly handles conversions from wall time, the required inputs to the trait, to ticks, which are used to track time for alarms.

Implementations

impl<A: 'static + Alarm<'static>> VirtualSchedulerTimer<A>

pub fn new(alarm: &'static A) -> Self

Trait Implementations

impl<A: 'static + Alarm<'static>> AlarmClient for VirtualSchedulerTimer<A>

pub 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: 'static + Alarm<'static>> SchedulerTimer for VirtualSchedulerTimer<A>

pub fn reset(&self)

Reset the SchedulerTimer.

pub fn start(&self, us: u32)

Start a timer for a process timeslice. The us argument is the length of the timeslice in microseconds.

pub fn arm(&self)

Arm the SchedulerTimer timer and ensure an interrupt will be generated.

pub fn disarm(&self)

Disarm the SchedulerTimer timer indicating an interrupt is no longer required.

pub fn get_remaining_us(&self) -> Option<u32>

Return the number of microseconds remaining in the process's timeslice if the timeslice is still active.