hlc

package

v0.3.0 Latest Latest Go to latest Published: Nov 19, 2024 License: MIT Imports: 9 Imported by: 2

Details

Copyright (c) Microsoft Corporation. Licensed under the MIT License.

This section is empty.

This section is empty.

func Set(hlc HybridLogicalClock) error

Set syncs the global HLC instance to the given HLC.

type HybridLogicalClock struct {
	Timestamp time.Time
	Counter   uint64
	NodeID    string
}

HybridLogicalClock provides a combination of physical and logical clocks used to track timestamps across a distributed system.

func Get() (HybridLogicalClock, error)

Get syncs the global HLC instance to the current time and returns it.

func Parse(name, value string) (HybridLogicalClock, error)

Parse the HLC from a string.

func (hlc HybridLogicalClock) Compare(other HybridLogicalClock) int

Compare this HLC value with another one.

func (hlc HybridLogicalClock) IsZero() bool

IsZero returns whether this HLC matches its zero value.

func (hlc HybridLogicalClock) String() string

String retrieves a serialized form of the HLC.

func (hlc HybridLogicalClock) Update(
	other HybridLogicalClock,
) (HybridLogicalClock, error)

Update an HLC based on another one and return the new value.