hlc

package module
v0.0.0-...-0610e7f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2017 License: BSD-3-Clause Imports: 2 Imported by: 0

README

HLC

Hybrid Logical Clocks in Go

http://www.cse.buffalo.edu/tech-reports/2014-04.pdf

GoDoc

Usage


package main

import (
	"log"

	"github.com/lafikl/hlc"
)

func main() {
	clock := hlc.NewWithPT(hlc.PT{Seconds: true})
	ts := clock.Now()

	// updates the clock time
	clock.Update(ts)

	// check ordering
	if ts.Less(clock.Now()) != true {
		log.Println("ts is less than current clock time")
	}
}



BSD 3-Clause License

Copyright (c) 2017, Khalid Lafi
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Documentation

Overview

Example
package main

import (
	"log"

	"github.com/lafikl/hlc"
)

func main() {
	clock := hlc.NewWithPT(hlc.PT{Seconds: true})
	ts := clock.Now()

	// updates the clock time
	clock.Update(ts)

	// check ordering
	if ts.Less(clock.Now()) != true {
		log.Println("ts is less than current clock time")
	}
}
Output:

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Clock

type Clock interface {
	Now() int64
}

type HLC

type HLC struct {
	// contains filtered or unexported fields
}

func New

func New() *HLC

func NewWithPT

func NewWithPT(pt Clock) *HLC

func (*HLC) Now

func (h *HLC) Now() Timestamp

Now should be called when sending an event or when a local event happens

func (*HLC) Update

func (h *HLC) Update(incoming Timestamp)

Update should be called when receive an event

type PT

type PT struct {
	// if true it'll use time.Now().Unix()
	Seconds bool
}

PT is physical time, it uses time.Now().UnixNano(). it's the default PT source in HLC.

func (PT) Now

func (p PT) Now() int64

Now returns the value of

type Timestamp

type Timestamp struct {
	// contains filtered or unexported fields
}

func (Timestamp) Less

func (t Timestamp) Less(incoming Timestamp) bool

Less compares timestamps by checking the timestamps first if they're equal then it uses the counters to break the tie. it returns true if incoming is less than t

func (Timestamp) String

func (t Timestamp) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL