quarp v0.3.1 Reactivity.Registry View Source

Link to this section Summary

Functions

Adds a signal to the registry under the given name.

The Registry is responsible for

Gets the consistency guarantee that is in use

Gets a signal by its name.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

Removes a signal from the registry under the given name.

Sets the consistency guarantee to use.

Start the registry

Subscribe to events from the signal registry. When a new signal is added, this is sent to the subscribers.

Unsubscribe a given pid from the registry events.

Link to this section Functions

Link to this function

add_signal(signal, name) View Source

Adds a signal to the registry under the given name.

The Registry is responsible for

  • keeping track of signals by their names,
  • holding the consistency guarantee that is in use, and
  • synchronizing signals and guarantee with other registries in order to create a globally consistent view of both.

Gets the consistency guarantee that is in use

Gets a signal by its name.

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 calling Supervisor.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.

Removes a signal from the registry under the given name.

Link to this function

set_guarantee(guarantee) View Source

Sets the consistency guarantee to use.

Start the registry

Subscribe to events from the signal registry. When a new signal is added, this is sent to the subscribers.

Unsubscribe a given pid from the registry events.