Skip to main content

DcpsTickDriver

Struct DcpsTickDriver 

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

Drives a runtime’s periodic tick from an external executor (tokio, an embedded scheduler, a manual test loop). Obtained via DcpsRuntime::tick_driver; only does useful work when the runtime was started with RuntimeConfig::external_tick = true.

Typical loop (the async crate’s spawn_in_tokio shape):

let mut driver = runtime.tick_driver();
let period = driver.tick_period();
while !driver.is_stopped() {
    driver.tick();
    tokio::time::sleep(period).await;
}

Implementations§

Source§

impl DcpsTickDriver

Source

pub fn tick_period(&self) -> Duration

Period the caller should wait between consecutive Self::tick calls (mirrors the internal zdds-tick thread’s tick_period).

Source

pub fn is_stopped(&self) -> bool

true once the runtime is shutting down (set by Drop/stop()). The driving task must then stop calling Self::tick and return so the runtime can be dropped cleanly.

Source

pub fn tick(&mut self)

Run one tick iteration: periodic SPDP announce, SEDP/WLP ticks, per-user-writer ticks, deadline/lifespan/liveliness checks. Equivalent to one pass of the internal zdds-tick loop body.

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.