Skip to main content

TimerControl

Struct TimerControl 

Source
pub struct TimerControl { /* private fields */ }
Expand description

Pure state machine for one logical timer identity.

Implementations§

Source§

impl TimerControl

Source

pub const fn generation(&self) -> u64

Return the latest allocated callback generation.

Source

pub const fn registration(&self) -> TimerRegistration

Return the current logical registration.

Source

pub fn schedule( &mut self, deadline_ns: u64, ) -> Result<TimerControlAction, TimerControlError>

Schedule a deadline, retaining an already scheduled earlier deadline.

Source

pub fn cancel(&mut self) -> Result<TimerControlAction, TimerControlError>

Cancel this timer, deferring cancellation safely when a callback runs.

Source

pub fn reconcile( &mut self, deadline_ns: u64, ) -> Result<TimerControlAction, TimerControlError>

Reconcile this timer to one authoritative deadline.

Source

pub const fn begin(&mut self, generation: u64) -> bool

Begin the scheduled generation, rejecting stale callbacks.

Source

pub fn complete( &mut self, generation: u64, directive_deadline_ns: Option<u64>, ) -> Result<TimerControlAction, TimerControlError>

Complete the running generation and arbitrate its proposed successor against commands received during execution.

Trait Implementations§

Source§

impl Debug for TimerControl

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for TimerControl

Source§

fn default() -> TimerControl

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.