Struct futures_intrusive::timer::GenericTimerService

pub struct GenericTimerService<MutexType: RawMutex> { /* fields omitted */ }

An asynchronously awaitable timer.

The timer operates on millisecond precision and makes use of a configurable clock source.

The timer allows to wait asynchronously either for a certain duration, or until the provided Clock reaches a certain timestamp.

In order to unblock tasks that are waiting on the timer, check_expirations must be called in regular intervals on this timer service.

The timer can either be running on a separate timer thread (in case a thread-safe timer type is utilize), or it can be integrated into an executor in order to minimize context switches.

Methods

impl<MutexType: RawMutex> GenericTimerService<MutexType>

pub fn new(clock: &'static dyn Clock) -> GenericTimerService<MutexType>

Creates a new Timer in the given state.

The Timer will query the provided Clock instance for the current time whenever required.

In order to create a create a clock which utilizes system time, StdClock can be utilized. In order to simulate time for test purposes, MockClock can be utilized.

pub fn next_expiration(&self) -> Option<u64>

Returns a timestamp when the next timer expires.

For thread-safe timers, the returned value is not precise and subject to race-conditions, since other threads can add timer in the meantime.

Therefore adding any timer to the GenericTimerService should also make sure to wake up the executor which polls for timeouts, in order to let it capture the latest change.

pub fn check_expirations(&self)

Checks whether any of the attached TimerFutures has expired. In this case the associated task is woken up.

Trait Implementations

impl<MutexType: RawMutex> Debug for GenericTimerService<MutexType>

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

Formats the value using the given formatter.

impl<MutexType: RawMutex> LocalTimer for GenericTimerService<MutexType>

Important traits for LocalTimerFuture<'a>

impl<'a> Future for LocalTimerFuture<'a> type Output = ();

fn delay(&self, delay: Duration) -> LocalTimerFuture

Returns a future that gets fulfilled after the given Duration

Important traits for LocalTimerFuture<'a>

impl<'a> Future for LocalTimerFuture<'a> type Output = ();

fn deadline(&self, timestamp: u64) -> LocalTimerFuture

Returns a future that gets fulfilled when the utilized Clock reaches the given timestamp.

impl<MutexType: RawMutex + Send> Send for GenericTimerService<MutexType>

impl<MutexType: RawMutex + Sync> Sync for GenericTimerService<MutexType>

impl<MutexType: RawMutex> Timer for GenericTimerService<MutexType> where
    MutexType: Sync, 

Important traits for TimerFuture<'a>

impl<'a> Future for TimerFuture<'a> type Output = ();

fn delay(&self, delay: Duration) -> TimerFuture

Returns a future that gets fulfilled after the given Duration

Important traits for TimerFuture<'a>

impl<'a> Future for TimerFuture<'a> type Output = ();

fn deadline(&self, timestamp: u64) -> TimerFuture

Returns a future that gets fulfilled when the utilized Clock reaches the given timestamp.