ringhash

Documentation

Overview

Implementation of a consistent ring hash: https://en.wikipedia.org/wiki/Consistent_hashing

Index

• type Hash
• type Ring
  • func New(replicas int, fn Hash) *Ring
  • func (ring *Ring) Add(keys ...string)
  • func (ring *Ring) Get(key string) string
  • func (ring *Ring) Len() int
  • func (ring *Ring) Signature() string

Types

type Hash

type Hash func(data []byte) uint32

type Ring

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

func New

func New(replicas int, fn Hash) *Ring

func (*Ring) Add

func (ring *Ring) Add(keys ...string)

Adds keys to the ring.

func (*Ring) Get

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

Get returns the closest item in the ring to the provided key.

func (*Ring) Len

func (ring *Ring) Len() int

Returns the number of keys in the ring.

func (*Ring) Signature

func (ring *Ring) Signature() string

Get a ring hash signature. Two identical ring hashes will have the same signature. Two hashes with different number of keys or replicas or hash functions will have different signatures.