Struct hybrid_clocks::Clock

pub struct Clock<S: ClockSource> { /* fields omitted */ }

The main clock type.

Methods

impl Clock<WallNS>

pub fn wall_ns() -> Clock<WallNS>

Returns a Clock that uses WallNS-clock time.

impl Clock<WallMS>

pub fn wall_ms() -> Clock<WallMS>

Returns a Clock that uses WallNS-clock time.

impl Clock<ManualClock>

pub fn manual(t: u64) -> Clock<ManualClock>

Returns a Clock that uses WallNS-clock time.

pub fn set_time(&mut self, t: u64)

impl<S: ClockSource> Clock<S>

pub fn new(src: S) -> Self

Creates a clock with src as the time provider.

pub fn new_with_max_diff(src: S, diff: S::Delta) -> Self

Creates a clock with src as the time provider, and diff as how far in the future we don't mind seeing updates from.

pub fn set_epoch(&mut self, epoch: u32)

Used to create a new "epoch" of clock times, mostly useful as a manual override when a cluster member has skewed the clock time far into the future.

pub fn now(&mut self) -> Timestamp<S::Time>

Creates a unique monotonic timestamp suitable for annotating messages we send.

pub fn observe(&mut self, msg: &Timestamp<S::Time>) -> Result<(), Error>

Accepts a timestamp from an incoming message, and updates the clock so that further calls to now will always return a timestamp that happens-after either locally generated timestamps or that of the input message. Returns an Error iff the delta from our local lock to the observed timestamp is greater than our configured limit.

Trait Implementations

impl<S: Clone + ClockSource> Clone for Clock<S> where
    S::Time: Clone,
    S::Delta: Clone, 

fn clone(&self) -> Clock<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + ClockSource> Debug for Clock<S> where
    S::Time: Debug,
    S::Delta: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.