Yggdrasil v5.0.0 Yggdrasil.Subscriber.Adapter.Elixir View Source
Yggdrasil subscriber 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.
Starts Elixir.Yggdrasil.Subscriber.Adapter.Elixir with a channel
and optional options
.
Link to this section Functions
Link to this function
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
Link to this function
start_link(channel, options \\ [])
View Source
start_link(channel, options \\ [])
View Source
start_link(Yggdrasil.Channel.t(), GenServer.options()) :: GenServer.on_start()
start_link(Yggdrasil.Channel.t(), GenServer.options()) :: GenServer.on_start()
Starts Elixir.Yggdrasil.Subscriber.Adapter.Elixir with a channel
and optional options
.