Struct clepsydra::GlobalTime

pub struct GlobalTime {
    pub milli_secs: u64,
    pub peer: PeerID,
    pub event: u64,
}

GlobalTimes are the fundamental timekeeping type in the system.

They have some interesting properties:

• They are totally ordered.
• They are assumed globally unique: there's a unique peer-ID component in each.
• They are issued monotonicaly-increasing: there's an event-counter at the end in case real time moves backwards or stalls.
• They are issued at each peer, without coordination.
• They do assume some level of real-time-clock availability on all peers generating them, but those clocks do not need to be very tightly synchronized. Larger skew will imply longer latency on each transaction but will not affect throughput as transactions execute asynchronously and in parallel.

The GlobalTime type is used in a variety of contexts, some of which are wrapped in newtypes to make it a bit less likely to misuse them. They are sometimes called "transaction IDs" or "tids", or "timestamps", or "ts", or "versions", or the ver component of a crate::KeyVer. All these synonyms arise from the OV paper and are reproduced here to attempt to retain similar terminology in each algorithm and protocol message. The various "watermarks" tracking the sets of transactions in each phase across the system are also GlobalTimes.

Fields

milli_secs: u64

peer: PeerID

event: u64

Implementations

impl GlobalTime

pub fn new(peer: PeerID, milli_secs: u64, event: u64) -> GlobalTime

pub fn max_for(peer: PeerID) -> GlobalTime

pub fn time_zero_for(peer: PeerID) -> GlobalTime

pub fn with_milli_sec(&self, milli_secs: u64) -> GlobalTime

pub fn prev_milli_sec(&self) -> GlobalTime

pub fn next_milli_sec(&self) -> GlobalTime

pub fn with_event(&self, event: u64) -> GlobalTime

pub fn prev_event(&self) -> GlobalTime

pub fn next_event(&self) -> GlobalTime

Trait Implementations

impl Clone for GlobalTime

pub fn clone(&self) -> GlobalTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GlobalTime

impl Debug for GlobalTime

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GlobalTime

pub fn default() -> GlobalTime

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for GlobalTime

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for GlobalTime

impl Hash for GlobalTime

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for GlobalTime

pub fn cmp(&self, other: &GlobalTime) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GlobalTime> for GlobalTime

pub fn eq(&self, other: &GlobalTime) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GlobalTime) -> bool

This method tests for !=.

impl PartialOrd<GlobalTime> for GlobalTime

pub fn partial_cmp(&self, other: &GlobalTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &GlobalTime) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &GlobalTime) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &GlobalTime) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &GlobalTime) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GlobalTime

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for GlobalTime

impl StructuralPartialEq for GlobalTime