Yggdrasil

v5.0.2

Yggdrasil

Yggdrasil v5.0.2 Yggdrasil.Publisher.Adapter behaviour View Source

Publisher adapter behaviour.

Link to this section Summary

Functions

__using__(_)

Use to implement Yggdrasil.Publisher.Adapter behaviour.

publish(publish, channel, message, options)

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

start_link(channel, options \\ [])

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

stop(pid)

Generic publisher adapter stopper that receives the pid.

Callbacks

publish(publisher, channel, message)

Callback for publishing a message in a channel using a publisher.

publish(publisher, channel, message, options)

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

start_link(namespace, options)

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

Link to this section Functions

Link to this macro

__using__(_)

View Source (macro)

Use to implement Yggdrasil.Publisher.Adapter behaviour.

Link to this function

publish(publish, channel, message, options)

View Source 
publish(GenServer.server(), Yggdrasil.Channel.t(), term(), keyword()) ::
  :ok | {:error, term()}

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

Link to this function

start_link(channel, options \\ [])

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

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

Link to this function

stop(pid)

View Source 
stop(GenServer.server()) :: :ok

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()}

Callback for publishing 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()
) :: :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.