View Source Cachex.Router behaviour (Cachex v4.0.2)

Module controlling routing behaviour definitions.

This module defines the router implementations for Cachex, allowing the user to route commands between nodes in a cache cluster. This means that users can provide their own routing and rebalancing logic without having to depend on it being included in Cachex.

Summary

Callbacks

children(cache, options)

Create a child specification to back a routing state.

init(cache, options)

Initialize a routing state for a cache.

nodes(state)

Retrieve the list of nodes from a routing state.

route(state, key)

Route a key to a node in a routing state.

Functions

connected()

Retrieve all currently connected nodes (including this one).

nodes(arg)

Retrieve all routable nodes for a cache.

route(cache, call)

Dispatches a call to an appropriate execution environment.

route(cache, module, call)

Executes a previously dispatched action..

Callbacks

children(cache, options)

@callback children(cache :: Cachex.t(), options :: Keyword.t()) :: Supervisor.child_spec()

Create a child specification to back a routing state.

init(cache, options)

@callback init(cache :: Cachex.t(), options :: Keyword.t()) :: any()

Initialize a routing state for a cache.

Please see all child implementations for supported options.

nodes(state)

@callback nodes(state :: any()) :: [atom()]

Retrieve the list of nodes from a routing state.

route(state, key)

@callback route(state :: any(), key :: any()) :: atom()

Route a key to a node in a routing state.

Functions

connected()

@spec connected() :: [atom()]

Retrieve all currently connected nodes (including this one).

nodes(arg)

@spec nodes(cache :: Cachex.t()) :: {:ok, [atom()]}

Retrieve all routable nodes for a cache.

route(cache, call)

(macro)

Dispatches a call to an appropriate execution environment.

This acts as a macro just to avoid the overhead of slicing up module names at runtime, when they can be guaranteed at compile time much more easily.

route(cache, module, call)

@spec route(Cachex.t(), atom(), {atom(), [any()]}) :: any()

Executes a previously dispatched action..