View Source Reginald (Reginald v0.0.2-rc.0.0.0)

Reginald is a simple distributed registry built on top of the built-in Erlang :pg module.

This module provides the public API of Reginald, while the internal modules provide the actual implementations.

Summary

Functions

See Reginald.Implementation.child_spec/1.

Callback implementation for ElixirExt.Registry.send/2.

See Reginald.Implementation.start_link/1.

Types

@type reg_mod() :: {atom(), term()}

Functions

@spec child_spec(Keyword.t()) :: Supervisor.child_spec()

See Reginald.Implementation.child_spec/1.

Link to this function

register_name(name, pid)

View Source
@spec register_name(name :: reg_mod(), pid()) :: :yes | :no

Callback implementation for ElixirExt.Registry.register_name/2.

@spec send(name :: reg_mod(), msg :: term()) :: pid()

Callback implementation for ElixirExt.Registry.send/2.

@spec start_link(Keyword.t()) :: Supervisor.on_start()

See Reginald.Implementation.start_link/1.

@spec unregister_name(name :: reg_mod()) :: :ok

Callback implementation for ElixirExt.Registry.unregister_name/1.

@spec whereis_name(name :: reg_mod()) :: pid() | :undefined

Callback implementation for ElixirExt.Registry.whereis_name/1.