Commanded v1.0.0 Commanded.Registration.Adapter behaviour View Source

Defines a behaviour for a process registry to be used by Commanded.

By default, Commanded will use a local process registry, defined in Commanded.Registration.LocalRegistry, that uses Elixir's Registry module for local process registration. This limits Commanded to only run on a single node. However the Commanded.Registration behaviour can be implemented by a library to provide distributed process registration to support running on a cluster of nodes.

Link to this section Summary

Types

config()

start_child_arg()

Callbacks

child_spec(application, config)

Return an optional supervisor spec for the registry

start_child(adapter_meta, name, supervisor, child_spec)

Starts a uniquely named child process of a supervisor using the given module and args.

start_link(adapter_meta, name, module, args)

Starts a uniquely named GenServer process for the given module and args.

supervisor_child_spec(adapter_meta, module, arg)

Use to start a supervisor.

via_tuple(adapter_meta, name)

Return a :via tuple to route a message to a process by its registered name

whereis_name(adapter_meta, name)

Get the pid of a registered name.

Link to this section Types

adapter_meta()

adapter_meta() :: map()

application()

application() :: Commanded.Application.t()

config()

config() :: Keyword.t()

start_child_arg()

start_child_arg() :: {module(), keyword()} | module()

Link to this section Callbacks

child_spec(application, config)

child_spec(application(), config()) ::
  {:ok, [:supervisor.child_spec() | {module(), term()} | module()],
   adapter_meta()}

Return an optional supervisor spec for the registry

start_child(adapter_meta, name, supervisor, child_spec)

start_child(
  adapter_meta(),
  name :: term(),
  supervisor :: module(),
  child_spec :: start_child_arg()
) :: {:ok, pid()} | {:error, term()}

Starts a uniquely named child process of a supervisor using the given module and args.

Registers the pid with the given name.

start_link(adapter_meta, name, module, args)

start_link(adapter_meta(), name :: term(), module :: module(), args :: any()) ::
  {:ok, pid()} | {:error, term()}

Starts a uniquely named GenServer process for the given module and args.

Registers the pid with the given name.

supervisor_child_spec(adapter_meta, module, arg)

supervisor_child_spec(adapter_meta(), module :: atom(), arg :: any()) ::
  :supervisor.child_spec()

Use to start a supervisor.

via_tuple(adapter_meta, name)

via_tuple(adapter_meta(), name :: term()) :: {:via, module(), name :: term()}

Return a :via tuple to route a message to a process by its registered name

whereis_name(adapter_meta, name)

whereis_name(adapter_meta(), name :: term()) :: pid() | :undefined

Get the pid of a registered name.

Returns :undefined if the name is unregistered.