View Source Yggdrasil.Adapter.Elixir (Yggdrasil v6.0.2)
Yggdrasil adapter for Elixir. The name of the channel can be any arbitrary term e.g:
First we subscribe to a channel:
iex> channel = [name: "elixir_channel"]
iex> Yggdrasil.subscribe(channel)
:ok
iex> flush()
{:Y_CONNECTED, ...}
Once connected, you can publish a message in that channel:
iex> Yggdrasil.publish(channel, "foo")
:ok
And the subscriber should receive the message:
iex> flush()
{:Y_EVENT, ..., "foo"}
Additionally, the subscriber can also unsubscribe from the channel:
iex> Yggdrasil.unsubscribe(channel)
:ok
iex> flush()
{:Y_DISCONNECTED, ...}
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Gets default backend.
Gets publisher module.
Gets publisher module only if the given module exists.
Gets subscriber module.
Gets subscriber module only if the given module exists.
Gets default transformer.
Registers adapter in Registry
.
Start task to register the adapter in the Registry
.
Link to this section Functions
Returns a specification to start this module under a supervisor.
arg
is passed as the argument to Task.start_link/1
in the :start
field
of the spec.
For more information, see the Supervisor
module,
the Supervisor.child_spec/2
function and the Supervisor.child_spec/0
type.
Specs
get_backend() :: atom()
Gets default backend.
Specs
Gets publisher module.
Specs
Gets publisher module only if the given module exists.
Specs
Gets subscriber module.
Specs
Gets subscriber module only if the given module exists.
Specs
get_transformer() :: atom()
Gets default transformer.
Specs
register() :: :ok
Registers adapter in Registry
.
Specs
Start task to register the adapter in the Registry
.