View Source Yggdrasil.Publisher.Adapter.Icon (ICON 2.0 SDK v0.2.3)

This modules defines a publisher ICON 2.0 adapter. However, it's not possible to publish messages in ICON 2.0 via Yggdrasil. Attempting to publish a message will always return an error.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

It returns error when trying to publish a message in ICON 2.0.

Starts a ICON 2.0 publisher with a namespace for the configuration. Additionally, you can add GenServer options.

Stops an ICON 2.0 publisher. Optionally, receives a stop reason (defaults to :normal) and a timeout in milliseconds (defaults to :infinity).

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
@spec publish(GenServer.name(), Yggdrasil.Channel.t(), term(), Keyword.t()) ::
  :ok | {:error, Icon.Schema.Error.t()}

It returns error when trying to publish a message in ICON 2.0.

Link to this function

start_link(namespace, options \\ [])

View Source
@spec start_link(term(), GenServer.options()) :: GenServer.on_start()

Starts a ICON 2.0 publisher with a namespace for the configuration. Additionally, you can add GenServer options.

Link to this function

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

View Source
@spec stop(GenServer.name(), term(), non_neg_integer() | :infinity) :: :ok

Stops an ICON 2.0 publisher. Optionally, receives a stop reason (defaults to :normal) and a timeout in milliseconds (defaults to :infinity).