Struct HlcGenerator 

pub struct HlcGenerator<S: ClockSource = UtcClock> { /* private fields */ }

Hybrid Logical Clock (HLC) generator.

Implementations

impl HlcGenerator<UtcClock>

pub fn new(max_drift: usize) -> Self

Creates a new HLC clock with the specified maximum drift.

Set max_drift to 0, if the clock is running in a single node settings (useful for generating timestamp-based monotonically increasing IDs). In such settings, there is no need to worry about drift, as no adjustments are made to the clock, i.e. update() is never called.

impl HlcGenerator<ManualClock>

pub fn manual(max_drift: usize) -> Self

Creates a new manual HLC clock with the specified maximum drift.

Useful for testing purposes, where manual timestamps are used.

pub fn set_current_timestamp(&self, timestamp: i64)

impl<S: ClockSource> HlcGenerator<S>

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<UtcClock>

fn default() -> Self

Creates a new HLC clock without any drift.