Flux MQTT v0.0.4 FluxMQTT View Source

An interface to connect to MQTT broker, sending and handling messages.

Link to this section Summary

Functions

connection(handler, opts \\ [])

Define a tuple with {Tortoise.Connection, specification} to be used as a child definition to the service supervision tree.

send(payload, topic, client_id, opts \\ [])

Send a message to the broker using the active MQTT service on the service supersivion tree.

Link to this section Functions

connection(handler, opts \\ [])

(since 0.0.1)

connection(module(), keyword()) :: {Tortoise.Connection, keyword()}

Define a tuple with {Tortoise.Connection, specification} to be used as a child definition to the service supervision tree.

Parameters

handler - A module which uses FluxMQTT.Handler (or Tortoise.Handler) responsible to handle messages received. Accepts module/0.
opts - A keyword list with connection settings. Definition is the same as application configuration and the opts defined here are merged with the application configuration. Can be blank. Accepts keyword/0.

Examples

iex> result = FluxMQTT.connection(Tortoise.Handler.Logger)
...> with {Tortoise.Connection, _specification} <- result, do: :passed
:passed

send(payload, topic, client_id, opts \\ [])

(since 0.0.1)

send(String.t(), String.t(), String.t(), keyword()) ::
  :ok | {:ok, reference()} | {:error, :unknown_connection}

Send a message to the broker using the active MQTT service on the service supersivion tree.

Parameters

payload - The message. Accepts String.t/0.
topic - The MQTT topic which the message will be sent. Accepts String.t/0.
client_id - The sender client id. Accepts String.t/0.
opts - The Tortoise.publish/4 options. Accepts keyword/0.

Examples

iex> opts = [
...>   client: [
...>     auth: [authenticate?: false],
...>     correlation: [create_correlation_id?: false]
...>   ]
...> ]
...> {connection, specification} = FluxMQTT.connection(Tortoise.Handler.Logger, opts)
...> connection.start_link(specification)
...> FluxMQTT.send("Hello, World!", "a/topic", "client")
:ok