Module hash_ring_node

An object which represents a node on a consistent hash ring.

Description

An object which represents a node on a consistent hash ring

data() = term()

The data of a ring_node().

It holds arbitrary user data.

key() = term()

The key of a ring_node().

It is used to decide location of the node on a ring.

option() = {weight, weight()}

weight:

A coefficient which is used to determine the virtual node count of the node.
The higher the value, the number of virtual nodes increases, likely to be more selected.
The default value is 1.

options() = [option()]

abstract datatype: ring_node()

A node on a ring.

weight() = number()

The non negative weight of a ring_node().

The more weight node occupies, the more space in a ring.

get_data/1	Gets the data of `Node`
get_key/1	Gets the key of `Node`
get_weight/1	Gets the weight of `Node`
is_node/1	Returns `true` if `X` is a `ring_node()`, otherwise `false`
make/1	Equivalent to `make(Key, Key)`.
make/2	Equivalent to `make(Key, Data, [])`.
make/3	Creates a new `ring_node()` object.