README
¶
本一致性哈希库支持自定义虚拟节点副本数，支持自定义哈希函数，支持添加删除节点或重置节点。 使用说明： 1、使用之前你需要用New函数创建一个hashring，参数有虚拟节点副本数和哈希函数 2、添加hash环上的node，如果有动态更新的话，可以添加和删除 3、通过Get方法获取一个数据对应到hash环上的哪个节点处理 样例代码可以参考test里面的代码。
The provided consistent hashing library supports customizing the number of virtual node replicas, defining custom hash functions, and adding, deleting, or resetting nodes. Usage instructions:
- Before using, create a hashring with the New function. The parameters for this function include the number of virtual node replicas and the desired hash function.
- Add nodes to the hash ring. If there are dynamic updates, nodes can be added and removed.
- Use the Get method to determine which node on the hash ring is responsible for processing a specific piece of data. Refer to the sample code in the tests for more details.
Documentation
¶
Overview ¶
Package consistenthash provides a flexible hash ring. 支持自定义虚拟节点副本数，支持自定义哈希函数，支持添加删除节点的一致性hash库。
Index ¶
- Variables
- type Hash32
- type HashRing
- func (m *HashRing) Add(nodes ...string) error
- func (m *HashRing) Get(key string) (string, error)
- func (m *HashRing) IsEmpty() bool
- func (m *HashRing) Remove(nodes ...string)
- func (m *HashRing) Reset(nodes ...string) error
- func (m *HashRing) ResetAll(replicas uint16, hash Hash32, nodes ...string) error
- func (m *HashRing) RingInfo() string
- type U32Slice
Constants ¶
This section is empty.
Variables ¶
var ( // ErrRingEmpty "ring empty" ErrRingEmpty = errors.New("ring empty") // ErrRingFull "ring full" ErrRingFull = errors.New("ring full") )
Functions ¶
This section is empty.
Types ¶
type HashRing ¶
type HashRing struct {
HashFunc Hash32 // hash func for key and for node
sync.RWMutex
// contains filtered or unexported fields
}
HashRing core struct for hashring 一致性hash环的结构体
func New ¶
New creates a new hash ring. With default hash function crc32. 创建hash环，默认hash函数为crc32.ChecksumIEEE
func (*HashRing) Add ¶
Add adds some nodes to the hashring. If return error，MUST ResetAll hashring, typically by adjusting the replicas! 返回错误，必须接收和处理
func (*HashRing) Reset ¶
Reset reset nodes If return error，MUST ResetAll hashring, typically by adjusting the replicas! 返回错误，必须接收和处理
Source Files