View Source Yggdrasil.Subscriber.Adapter behaviour (Yggdrasil v6.0.2)

Subscriber adapter behaviour.

Link to this section Summary

Callbacks

Callback to start a subscriber with a channel, a publisher and some GenServer options.

Functions

Use to implement Yggdrasil.Subscriber.Adapter behaviour.

Generic subscriber adapter starter that receives a channel, a publisher and an optional GenServer options.

Generic subscriber adapter stopper that receives the pid and optional reason and timeout.

Link to this section Callbacks

Link to this callback

start_link( channel, options )

View Source

Specs

start_link(
  channel :: Yggdrasil.Channel.t(),
  options :: GenServer.options()
) :: GenServer.on_start()

Callback to start a subscriber with a channel, a publisher and some GenServer options.

Link to this section Functions

Use to implement Yggdrasil.Subscriber.Adapter behaviour.

Link to this function

start_link(channel, options \\ [])

View Source

Specs

Generic subscriber adapter starter that receives a channel, a publisher and an optional GenServer options.

Link to this function

stop(pid, reason \\ :normal, timeout \\ :infinity)

View Source

Specs

stop(pid() | GenServer.name(), term(), :infinity | pos_integer()) :: :ok

Generic subscriber adapter stopper that receives the pid and optional reason and timeout.