Struct VmTimerPeriodic

pub struct VmTimerPeriodic { /* private fields */ }

An abstraction over VmTimeAccess that streamlines the process of setting up a periodic timer.

Implementations

impl VmTimerPeriodic

pub fn new(vmtime_access: VmTimeAccess) -> Self

Create a new periodic timer, backed by the given VmTimeAccess.

pub fn cancel(&mut self)

Cancel the timer.

If the timer isn’t running, this method is a no-op.

pub fn start(&mut self, period: Duration)

Start the timer, configuring it to fire at the specified period.

If the timer is currently running, the timer will be cancelled + restarted.

pub fn is_running(&self) -> bool

Check if the timer is currently running.

pub fn poll_timeout(&mut self, cx: &mut Context<'_>) -> Poll<VmTime>

Polls the timer.

Returns Poll::Ready(now) when the timer is past-due, returning Poll::Pending otherwise.

Trait Implementations

impl Inspect for VmTimerPeriodic

fn inspect(&self, req: Request<'_>)

Inspects the object.