hlc

Documentation

Index

• Variables
• func CurrentTimeInMS() int64
• type HLC
  • func NewHLC(pt int64) *HLC
  • func (hlc *HLC) Now() Timestamp
  • func (hlc *HLC) ReadClock() Timestamp
  • func (hlc *HLC) Update(t Timestamp) Timestamp
• type Timestamp
  • func NewTimestamp(pt int64, lc int16) *Timestamp
  • func NewTimestampBytes(ts []byte) *Timestamp
  • func NewTimestampI64(hlc int64) *Timestamp
  • func NewTimestampPt(pt int64) *Timestamp
  • func (t *Timestamp) Compare(t2 *Timestamp) int
  • func (t Timestamp) GetLogicalTime() int16
  • func (t Timestamp) GetPhysicalTime() int64
  • func (t Timestamp) GoTime() time.Time
  • func (t *Timestamp) IncrementLogical()
  • func (t *Timestamp) ResetLogical()
  • func (t *Timestamp) SetLogicalTime(lc int16)
  • func (t *Timestamp) SetPhysicalTime(pt int64)
  • func (t Timestamp) String() string
  • func (t Timestamp) ToBytes() []byte
  • func (t Timestamp) ToInt64() int64

Variables

var (
	// MaxTimestamp is the max value allowed for Timestamp.
	MaxTimestamp = Timestamp{PhysicalTime: math.MaxInt64, LogicalTime: math.MaxInt16}
	// MinTimestamp is the min value allowed for Timestamp.
	MinTimestamp = Timestamp{PhysicalTime: 0, LogicalTime: 0}
)

Timestamp constant values.

Functions

func CurrentTimeInMS

func CurrentTimeInMS() int64

Types

type HLC

type HLC struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

var (
	//HLC
	HLClock *HLC
)

func NewHLC

func NewHLC(pt int64) *HLC

initialize HLC with a given physical time

func (*HLC) Now

func (hlc *HLC) Now() Timestamp

func (*HLC) ReadClock

func (hlc *HLC) ReadClock() Timestamp

func (*HLC) Update

func (hlc *HLC) Update(t Timestamp) Timestamp

type Timestamp

type Timestamp struct {
	PhysicalTime int64
	LogicalTime  int16
}

func NewTimestamp

func NewTimestamp(pt int64, lc int16) *Timestamp

func NewTimestampBytes

func NewTimestampBytes(ts []byte) *Timestamp

func NewTimestampI64

func NewTimestampI64(hlc int64) *Timestamp

Creates HLC from I64 representation of HLC time

func NewTimestampPt

func NewTimestampPt(pt int64) *Timestamp

func (*Timestamp) Compare

func (t *Timestamp) Compare(t2 *Timestamp) int

func (Timestamp) GetLogicalTime

func (t Timestamp) GetLogicalTime() int16

func (Timestamp) GetPhysicalTime

func (t Timestamp) GetPhysicalTime() int64

func (Timestamp) GoTime

func (t Timestamp) GoTime() time.Time

GoTime converts the timestamp to a time.Time.

func (*Timestamp) IncrementLogical

func (t *Timestamp) IncrementLogical()

func (*Timestamp) ResetLogical

func (t *Timestamp) ResetLogical()

func (*Timestamp) SetLogicalTime

func (t *Timestamp) SetLogicalTime(lc int16)

func (*Timestamp) SetPhysicalTime

func (t *Timestamp) SetPhysicalTime(pt int64)

func (Timestamp) String

func (t Timestamp) String() string

func (Timestamp) ToBytes

func (t Timestamp) ToBytes() []byte

func (Timestamp) ToInt64

func (t Timestamp) ToInt64() int64

Converts timestamp into Int64 representation of HLC