ExRingRing.Domain.Entities.Node (ex_ring_ring v0.1.0)

Copy Markdown

Represents a node in the consistent hash ring.

A node has a key (used for hashing), data (user-defined payload), and weight (used to determine virtual node count).

Summary

Types

t()

Functions

get_data(node)

Gets the node data.

get_key(node)

Gets the node key.

get_weight(node)

Gets the node weight.

is_node(arg1)

Checks if the given term is a valid node.

make(key)

Creates a new node with the given key.

make(key, data)

Creates a new node with the given key and data.

make(key, data, weight)

Creates a new node with the given key, data, and weight or options.

Types

t()

@type t() :: %ExRingRing.Domain.Entities.Node{
  data: term(),
  key: term(),
  weight: number()
}

Functions

get_data(node)

@spec get_data(t()) :: term()

Gets the node data.

get_key(node)

@spec get_key(t()) :: term()

Gets the node key.

get_weight(node)

@spec get_weight(t()) :: number()

Gets the node weight.

is_node(arg1)

@spec is_node(term()) :: boolean()

Checks if the given term is a valid node.

make(key)

@spec make(term()) :: t()

Creates a new node with the given key.

make(key, data)

@spec make(term(), term()) :: t()

Creates a new node with the given key and data.

make(key, data, weight)

@spec make(term(), term(), number() | keyword()) :: t()
@spec make(term(), term(), keyword()) :: t()

Creates a new node with the given key, data, and weight or options.