consistenthash

Documentation

Index

• Constants
• type Hash
• type Ring
  • func New(fn Hash, tokensPerNode int, initialNodes ...string) *Ring
  • func (r *Ring) AddNodes(nodes ...string)
  • func (r *Ring) Hash(key string) string
  • func (r *Ring) IsEmpty() bool

Constants

const DefaultTokensPerNode = 100

DefaultTokensPerNode is the default number of virtual nodes per node.

Types

type Hash

type Hash func(data string) uint64

Hash is a function computing a 64-bit digest.

var DefaultHash Hash = xxhash.Sum64String

DefaultHash is the default Hash used by Ring.

type Ring

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

Ring implements consistent hashing, aka ring hash (not thread-safe). It hashes nodes and keys onto a ring of tokens. Keys are mapped to the next node on the ring.

func New

func New(fn Hash, tokensPerNode int, initialNodes ...string) *Ring

New creates a new hash ring.

func (*Ring) AddNodes

func (r *Ring) AddNodes(nodes ...string)

func (*Ring) Hash

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

func (*Ring) IsEmpty

func (r *Ring) IsEmpty() bool