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 ...string)
  • func (m *Map) Get(key string) string
  • func (m *Map) GetWithFilters(key string, filters ...func(string) bool) string
  • func (m *Map) IsEmpty() bool
  • func (m *Map) Remove(keys ...string)

Types

type Hash

type Hash func(data []byte) uint32

type Map

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

func New

func New(replicas int, fn Hash) *Map

func (*Map) Add

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

Add adds some keys to the hash.

func (*Map) Get

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

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

func (*Map) GetWithFilters

func (m *Map) GetWithFilters(key string, filters ...func(string) bool) string

GetWithFilters gets the closest item in the hash to which passes all filters.

func (*Map) IsEmpty

func (m *Map) IsEmpty() bool

IsEmpty returns true if there are no items available.

func (*Map) Remove

func (m *Map) Remove(keys ...string)

Remove removes keys from existing hash ring.