ExRingRing.Application.Services.HashRingService (ex_ring_ring v0.1.0)

Application service for hash ring operations.

This is the main entry point for the application layer.

Summary

Functions

add_node(ring, node)

Adds a single node to the ring.

add_nodes(ring, nodes)

Adds nodes to the ring.

collect_nodes(ring, item, count)

Collects N nodes for an item (for replication).

create_ring(nodes, opts \\ [])

Creates a new hash ring.

create_ring_from_keys(keys, opts \\ [])

Creates a new hash ring from keys.

empty?(ring)

Checks if ring is empty.

find_node(ring, item)

Finds the node responsible for an item.

get_node_count(ring)

Gets the node count.

get_nodes(ring)

Gets all nodes in the ring.

remove_node(ring, key)

Removes a single node from the ring.

remove_nodes(ring, keys)

Removes nodes from the ring.

Functions

add_node(ring, node)

@spec add_node(
  ExRingRing.Domain.Entities.Ring.t(),
  ExRingRing.Domain.Entities.Node.t()
) ::
  ExRingRing.Domain.Entities.Ring.t()

Adds a single node to the ring.

add_nodes(ring, nodes)

@spec add_nodes(ExRingRing.Domain.Entities.Ring.t(), [
  ExRingRing.Domain.Entities.Node.t()
]) ::
  ExRingRing.Domain.Entities.Ring.t()

Adds nodes to the ring.

collect_nodes(ring, item, count)

@spec collect_nodes(ExRingRing.Domain.Entities.Ring.t(), term(), non_neg_integer()) ::
  [
    ExRingRing.Domain.Entities.Node.t()
  ]

Collects N nodes for an item (for replication).

create_ring(nodes, opts \\ [])

@spec create_ring(
  [ExRingRing.Domain.Entities.Node.t()],
  keyword()
) :: ExRingRing.Domain.Entities.Ring.t()

Creates a new hash ring.

create_ring_from_keys(keys, opts \\ [])

@spec create_ring_from_keys(
  [atom() | binary() | integer()],
  keyword()
) :: ExRingRing.Domain.Entities.Ring.t()

Creates a new hash ring from keys.

empty?(ring)

@spec empty?(ExRingRing.Domain.Entities.Ring.t()) :: boolean()

Checks if ring is empty.

find_node(ring, item)

@spec find_node(ExRingRing.Domain.Entities.Ring.t(), term()) ::
  {:ok, ExRingRing.Domain.Entities.Node.t()} | :error

Finds the node responsible for an item.

get_node_count(ring)

@spec get_node_count(ExRingRing.Domain.Entities.Ring.t()) :: non_neg_integer()

Gets the node count.

get_nodes(ring)

@spec get_nodes(ExRingRing.Domain.Entities.Ring.t()) :: [
  ExRingRing.Domain.Entities.Node.t()
]

Gets all nodes in the ring.

remove_node(ring, key)

@spec remove_node(ExRingRing.Domain.Entities.Ring.t(), atom() | binary() | integer()) ::
  ExRingRing.Domain.Entities.Ring.t()

Removes a single node from the ring.

remove_nodes(ring, keys)

@spec remove_nodes(ExRingRing.Domain.Entities.Ring.t(), [
  atom() | binary() | integer()
]) ::
  ExRingRing.Domain.Entities.Ring.t()

Removes nodes from the ring.