Struct HlcGenerator

pub struct HlcGenerator<T: CurrentTimestamp = UtcTimestamp> { /* private fields */ }

Hybrid Logical Clock (HLC) generator.

Implementations

impl<T: CurrentTimestamp> HlcGenerator<T>

pub fn new() -> Self

Creates a new HLC clock without any drift.

Whenever the clock running on a single node is required, there is no need to worry about drift, as no adjustments are made to the clock, i.e. update() is never called.

pub fn with_max_drift(max_drift: usize) -> Self

Creates a new HLC clock with the specified maximum drift.

pub fn set_max_drift(&self, max_drift: usize)

Update the maximum drift.

pub fn ts_provider(&self) -> Arc<T>

Get timestamp provider.

Useful for testing purposes, where manual timestamps are used.

pub fn timestamp(&self) -> HlcTimestamp

Current timestamp.

Use next_timestamp() to get the timestamp for local or send events.

pub fn next_timestamp(&self) -> Option<HlcTimestamp>

Timestamp for the local or send event.

pub fn update(&self, incoming_state: &HlcTimestamp) -> HlcResult<HlcTimestamp>

Adjust the clock based on incoming timestamp.

Usually this happens when a timestamp is received from another node. An error may occur if drift is exceeded (if max_drift is set to 0, then such a check is ignored).

Updated timestamp is returned.

Trait Implementations

impl Default for HlcGenerator

fn default() -> Self

Returns the “default value” for a type.