elsa v0.10.0 Elsa.Registry
Implements a custom version of the Registry for Elsa, allowing the registration of shared processes like brod clients as well as processes started under brod supervision.
Saves the process identifier-to-name key/value pairs to ETS.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Register the pid of a process to the registry under a given name.
Select all records within the registry and return them as a list.
Wraps the Kernel module send/2
function with a safe call to
ensure the receiving process is defined.
Start the Elsa registery process and link it to the current process. Creates the process registry table in ETS and traps exits during the init process.
De-register the process name from its associated pid within the registry.
Lookup a pid from within the registry by name.
Link to this section Functions
child_spec(init_arg)
Returns a specification to start this module under a supervisor.
See Supervisor
.
init(args)
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
register_name(arg, pid)
Register the pid of a process to the registry under a given name.
select_all(registry)
Select all records within the registry and return them as a list.
send(arg, msg)
Wraps the Kernel module send/2
function with a safe call to
ensure the receiving process is defined.
start_link(args)
start_link(keyword()) :: GenServer.on_start()
start_link(keyword()) :: GenServer.on_start()
Start the Elsa registery process and link it to the current process. Creates the process registry table in ETS and traps exits during the init process.
unregister_name(arg)
De-register the process name from its associated pid within the registry.
whereis_name(arg)
Lookup a pid from within the registry by name.