@spec children(cache :: Cachex.t(), options :: Keyword.t()) :: [
  Supervisor.child_spec()
]

Create a child specification to back a ring routing state.

@spec included?(
  node :: binary() | node(),
  includes :: [binary() | Regex.t()],
  excludes :: [binary() | Regex.t()]
) :: boolean()

Returns whether a node is included given the provided patterns.

@spec init(cache :: Cachex.t(), options :: Keyword.t()) :: ExHashRing.Ring.ring()

Initialize a ring routing state for a cache.

Options

• :nodes

  The :nodes option allows a user to provide a list of nodes to treat as a cluster. If this is not provided, the cluster will be inferred by using Node.self/0 and Node.list/1.

• :monitor

  This option specifies whether to monitor Erlang :nodeup and :nodedown events and scale this ring to add/remove nodes dynamically. This defaults to false, but if you're using this router it's likely you want this enabled.

• :monitor_excludes

  This option allows the developer to provide a list of patterns to exclude nodes from joining automatically when monitoring is enabled. Patterns can be provided as either binaries or Regex.

• :monitor_includes

  This option allows the developer to provide a list of patterns to validate nodes before allowing them to join the ring. Patterns can be provided as either binaries or Regex.

• :monitor_type

  The type of nodes to listen for and dynamically add to the internal ring. This defaults to :all, but can be any value accepted by the OTP function :net_kernel.monitor_nodes/2.

@spec nodes(ring :: ExHashRing.Ring.t()) :: {:ok, [atom()]}

Retrieve the list of nodes from a ring routing state.

@spec route(ring :: ExHashRing.Ring.t(), key :: any()) :: {:ok, atom()}

Route a key to a node in a ring routing state.