consistenthash

Documentation

Overview

Package consistenthash provides an implementation of a ring hash.

Index

• type Hash
• type Map
  • func New(replicas int, fn Hash) *Map
  • func (m *Map) Add(keys ...int)
  • func (m *Map) Get(key string) int
  • func (m *Map) IsEmpty() bool

Types

type Hash

type Hash func(data []byte) uint32

Hash defines the function of hash

type Map

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

Map contains the info

func New

func New(replicas int, fn Hash) *Map

New allocates and returns a new Map

func (*Map) Add

func (m *Map) Add(keys ...int)

Add adds some keys to the hash.

func (*Map) Get

func (m *Map) Get(key string) int

Get gets the closest item in the hash to the provided key.

func (*Map) IsEmpty

func (m *Map) IsEmpty() bool

IsEmpty returns true if there are no items available.