Commanded v0.19.1 Commanded.Registration.LocalRegistry View Source

Local process registration, restricted to a single node, using Elixir's Registry.

Link to this section Summary

Functions

Return an optional supervisor spec for the registry

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

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

Starts a supervisor.

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

Get the pid of a registered name.

Link to this section Functions

Return an optional supervisor spec for the registry

Link to this function

start_child(name, supervisor, child_spec)

View Source
start_child(
  name :: term(),
  supervisor :: module(),
  child_spec :: Commanded.Registration.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.

Link to this function

start_link(name, module, args)

View Source
start_link(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.

Link to this function

supervisor_child_spec(module, arg)

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

Starts a supervisor.

Link to this function

via_tuple(name)

View Source
via_tuple(name :: term()) :: {:via, module(), name :: term()}

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

Link to this function

whereis_name(name)

View Source
whereis_name(name :: term()) :: pid() | :undefined

Get the pid of a registered name.

Returns :undefined if the name is unregistered.