off_broadway_mqtt v0.1.0 OffBroadway.MQTT View Source

A broadway producer for MQTT topic subscriptions.

Link to this section Summary

Functions

Returns the runtime configuration for OffBroadway.MQTT.

Adds the second argument as error to one or many message(s).

Returns the name for the queue belonging to the given topic.

Returns the name for the queue belonging to the given topic.

Returns the topic name from a queue_name/0.

Utility function to build a for the running application unique client id that can be used when connecting with the broker.

Link to this section Types

Link to this type

qos() View Source
qos() :: 0 | 1 | 2

Link to this type

queue_name() View Source
queue_name() :: GenServer.name() | {:via, Registry, {atom(), topic()}}

Link to this type

subscription() View Source
subscription() :: {topic(), qos()}

Link to this section Functions

Returns the runtime configuration for OffBroadway.MQTT.

See f:OffBroadway.MQTT.Config.new/1 for more details.

Adds the second argument as error to one or many message(s).

Link to this function

queue_name(topic) View Source
queue_name(topic()) :: {:via, Registry, {atom(), topic()}}

Returns the name for the queue belonging to the given topic.

Link to this function

queue_name(map, topic) View Source
queue_name(config(), topic()) :: {:via, Registry, {atom(), topic()}}

Returns the name for the queue belonging to the given topic.

Link to this function

topic_from_queue_name(arg) View Source
topic_from_queue_name(queue_name()) :: topic()

Returns the topic name from a queue_name/0.

Link to this function

unique_client_id(config \\ :default) View Source
unique_client_id(:default | config()) :: String.t()

Utility function to build a for the running application unique client id that can be used when connecting with the broker.

This ensures that multiple clients from the same application don't kick each other from the broker in case the broker does not allow multiple connections with the same clent id.