Struct Clock 

pub struct Clock(/* private fields */);

Implementations

impl Clock

pub fn new(tb: Option<Box<NonBlockTickBridge>>) -> Option<Self>

Creates a new Clock instance collocated with application thread. It is recommended to create collocated Clock for message-based applications, especially when each application instance is anchored to a dedicated thread. This ensures that the clock is synchronized with the application thread, allowing all relevant timers to be handled within the same thread for optimal performance.

Panics if too many instances are created. The instance will persist until the process is closed. Implements the Copy trait, maintaining only one real instance.

Arguments

• tb: Tick bridge, a proxy to pass the tick to the clock instance when the clock is collocated with application thread, otherwise, None.

Returns

The newly created Clock instance.

pub fn take_thread_handle() -> Option<JoinHandle<()>>

Takes the thread handle of the Timer module for graceful shutdown.

Returns

The thread handle for the Timer module shutdown.

pub fn terminate_for_process_exit()

Terminates the Timer module.

pub fn on_tick(self, tick: Tick) -> AnyResult<()>

In case of clock instance is collocated with application thread, at the end of the path of relaying Tick, the application shall invoke clock.on_tick() to send the event to relevant instance. See the sample for TickBridge.

pub fn len(self) -> isize

Retrieves the number of timer instances residing on the Clock.

Returns

The count of timer instances.

pub fn now(self) -> u64

Retrieves the current tick of the Clock.

Returns

The current tick.

Trait Implementations

impl Clone for Clock

fn clone(&self) -> Clock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Clock