View Source Yggdrasil.Adapter.Bridge (Yggdrasil v6.0.2)

Yggdrasil bridge adapter. The name of the channel is a valid remote Yggdrasil.Channel e.g:

First we subscribe to a channel:

iex> channel = [name: [name: "remote_channel"], adapter: :bridge]
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.

Splits channels in a bridge channel.

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

get_publisher_module() :: {:ok, module()} | {:error, term()}

Gets publisher module.

Link to this function

get_publisher_module(module)

View Source

Specs

get_publisher_module(nil | module()) :: {:ok, module()} | {:error, term()}

Gets publisher module only if the given module exists.

Specs

get_subscriber_module() :: {:ok, module()} | {:error, term()}

Gets subscriber module.

Link to this function

get_subscriber_module(module)

View Source

Specs

get_subscriber_module(nil | module()) :: {:ok, module()} | {:error, term()}

Gets subscriber module only if the given module exists.

Specs

get_transformer() :: atom()

Gets default transformer.

Specs

register() :: :ok

Registers adapter in Registry.

Specs

split_channels(Yggdrasil.Channel.t()) ::
  {:ok, {Yggdrasil.Channel.t(), Yggdrasil.Channel.t()}} | {:error, term()}

Splits channels in a bridge channel.

Specs

start_link(term()) :: {:ok, pid()}

Start task to register the adapter in the Registry.