Struct veilid_tools::TickTask

pub struct TickTask<E: Send + 'static> { /* private fields */ }

Runs a single-future background processing task, attempting to run it once every ‘tick period’ microseconds. If the prior tick is still running, it will allow it to finish, and do another tick when the timer comes around again. One should attempt to make tasks short-lived things that run in less than the tick period if you want things to happen with regular periodicity.

Implementations

impl<E: Send + 'static> TickTask<E>

pub fn new_us(tick_period_us: u64) -> Self

pub fn new_ms(tick_period_ms: u32) -> Self

pub fn new(tick_period_sec: u32) -> Self

pub fn set_routine( &self, routine: impl Fn(StopToken, u64, u64) -> SendPinBoxFuture<Result<(), E>> + Send + Sync + 'static )

pub fn is_running(&self) -> bool

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

pub async fn stop(&self) -> Result<(), E>

pub async fn tick(&self) -> Result<(), E>

pub async fn try_tick_now(&self) -> Result<bool, E>