yggdrasil v4.0.0 Yggdrasil.Publisher.Adapter behaviour View Source

Publisher adapter behaviour.

Link to this section Summary

Functions

Use to implement Yggdrasil.Publisher.Adapter behaviour

Generic publisher adapter publish function. Publisher a message in a channel using a publisher and some options

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

Generic publisher adapter stopper that receives the pid

Callbacks

Publishes a message in a channel using a publisher

Publishes a message in a channel using a publisher and some options

Callback to start a publisher with a namespace and some GenServer options

Link to this section Functions

Use to implement Yggdrasil.Publisher.Adapter behaviour.

Link to this function publish(publisher, channel, message, options) View Source

Generic publisher adapter publish function. Publisher a message in a channel using a publisher and some options.

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

Generic publisher adapter stopper that receives the pid.

Link to this section Callbacks

Link to this callback publish(publisher, channel, message) View Source
publish(
  publisher :: GenServer.server(),
  channel :: Yggdrasil.Channel.t(),
  message :: term()
) :: :ok | {:error, term()}

Publishes a message in a channel using a publisher.

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

Publishes a message in a channel using a publisher and some options.

Link to this callback start_link(namespace, options) View Source
start_link(namespace :: atom(), options :: GenServer.options()) ::
  GenServer.on_start()

Callback to start a publisher with a namespace and some GenServer options.