yggdrasil v3.3.1 Yggdrasil.Publisher.Adapter.Redis View Source

Yggdrasil publisher adapter for Redis. The name of the channel must be a binary e.g:

Subscription to channel:

iex(1)> channel = %Yggdrasil.Channel{name: "redis_channel", adapter: :redis}
iex(2)> Yggdrasil.subscribe(channel)
:ok
iex(3)> flush()
{:Y_CONNECTED, %Yggdrasil.Channel{name: "redis_channel", (...)}}

Publishing message:

iex(4)> Yggdrasil.publish(channel, "foo")
:ok

Subscriber receiving message:

iex(5)> flush()
{:Y_EVENT, %Yggdrasil.Channel{name: "redis_channel", (...)}, "foo"}

The subscriber can also unsubscribe from the channel:

iex(6)> Yggdrasil.unsubscribe(channel)
:ok
iex(7)> flush()
{:Y_DISCONNECTED, %Yggdrasil.Channel{name: "redis_channel", (...)}}

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Publishes a message in a channel using a publisher and optional unused options

Starts a Redis publisher with a namespace. Additianally you can add GenServer options

Stops a Redis publisher

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function publish(publisher, channel, message, options \\ []) View Source
publish(GenServer.server(), Yggdrasil.Channel.t(), term(), Keyword.t()) ::
  :ok | {:error, term()}

Publishes a message in a channel using a publisher and optional unused options.

Link to this function start_link(namespace, options \\ []) View Source
start_link(term(), GenServer.options()) :: GenServer.on_start()

Starts a Redis publisher with a namespace. Additianally you can add GenServer options.

Stops a Redis publisher.