.. _vnx.mqtt.Proxy:

vnx.mqtt.Proxy
==============

.. cpp:namespace:: vnx::mqtt::Proxy

Module
------

The `vnx.mqtt.Proxy` module provides a way to connect to an :ref:`MQTT <mqtt>` broker.


Options
-------


.. cpp:member:: string address = "tcp://localhost:1883"

	Address of the MQTT broker to connect to.

.. cpp:member:: string client_id = "vnx-mqtt"

	Unique client id.

.. cpp:member:: map<vnx.TopicPtr, string> export_map

	Mapping of internal topics to be mapped to MQTT topics.

.. cpp:member:: map<vnx.TopicPtr, export_t> export_map_ex

	Same as ``export_map`` but with more options. See :ref:`vnx.mqtt.export_t`.

.. cpp:member:: map<string, vnx.TopicPtr> import_map

	Mapping of MQTT topics to be mapped to internal topics.
	MQTT-style wildcards are allowed, but only without overlaps.

.. cpp:member:: map<string, import_t> import_map_ex

	Same as ``import_map`` but with more options. See :ref:`vnx.mqtt.import_t`.

.. cpp:member:: optional<last_will_t> last_will

	Optionally sets the MQTT `Last-Will` message. See :ref:`vnx.mqtt.last_will_t`.

.. cpp:member:: string topic_prefix = ""

	Optional prefix that will be prepended to all MQTT topic names.

.. cpp:member:: string username

	Optional user name for autentication.

.. cpp:member:: string password

	Optional password for authentication.

.. cpp:member:: int connect_timeout = 1

.. cpp:member:: int keepalive_interval = 60

.. cpp:member:: bool clean_session = true

	If broker should always create a new session.

.. cpp:member:: bool wait_for_ack = true

	Every message must be acknowledged before the next can be sent

.. cpp:member:: int connect_interval_ms = 1000

	Interval in which to attempt to connect.