consistenthash

package module

v1.0.0 Latest Latest Go to latest Published: Nov 22, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This library implements consistent hash introduced in this paper. This library is for learning purposes only.

Checkout this blog post for more info.

This section is empty.

View Source

var ErrNodeNotFound = errors.New("node not found")

This section is empty.

type Node struct {
	Id     string
	HashId uint32
}

Node is a single entity in a ring.

func NewNode(id string) *Node

type Nodes []*Node

func (n Nodes) Len() int

Nodes implement sort.Interface.

func (n Nodes) Less(i, j int) bool

func (n Nodes) Swap(i, j int)

type Ring struct {
	Nodes Nodes

	sync.RWMutex
}

Ring is a network of distributed nodes.

func NewRing() *Ring

func (r *Ring) AddNode(id string)

func (r *Ring) Get(key string) string

Get returns the node closest to the key specified as argument, from the nodes ring.

func (r *Ring) RemoveNode(id string) error