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
config()
View Source
config() :: OffBroadway.MQTT.Config.t()
config() :: OffBroadway.MQTT.Config.t()
qos()
View Source
qos() :: 0 | 1 | 2
qos() :: 0 | 1 | 2
queue_name()
View Source
queue_name() :: GenServer.name() | {:via, Registry, {atom(), topic()}}
queue_name() :: GenServer.name() | {:via, Registry, {atom(), topic()}}
subscription() View Source
topic()
View Source
topic() :: binary()
topic() :: binary()
Link to this section Functions
config(config_opts \\ :default)
View Source
config(:default | OffBroadway.MQTT.Config.options()) ::
OffBroadway.MQTT.Config.t()
config(:default | OffBroadway.MQTT.Config.options()) :: OffBroadway.MQTT.Config.t()
Returns the runtime configuration for OffBroadway.MQTT.
See f:OffBroadway.MQTT.Config.new/1
for more details.
fail_msg(messages, exception)
View Source
fail_msg([Broadway.Message.t()], Exception.t()) :: [Broadway.Message.t()]
fail_msg(Broadway.Message.t(), Exception.t()) :: Broadway.Message.t()
fail_msg([Broadway.Message.t()], Exception.t()) :: [Broadway.Message.t()]
fail_msg(Broadway.Message.t(), Exception.t()) :: Broadway.Message.t()
Adds the second argument as error to one or many message(s).
queue_name(topic) View Source
Returns the name for the queue belonging to the given topic.
queue_name(map, topic) View Source
Returns the name for the queue belonging to the given topic.
topic_from_queue_name(arg)
View Source
topic_from_queue_name(queue_name()) :: topic()
topic_from_queue_name(queue_name()) :: topic()
Returns the topic name from a queue_name/0
.
unique_client_id(config \\ :default) View Source
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.