.. index:: pair: class; NRPMQTTClient
.. _doxid-class_n_r_p_m_q_t_t_client:

class NRPMQTTClient
===================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <nrp_mqtt_client.h>
	
	class NRPMQTTClient {
	public:
		// construction
	
		:ref:`NRPMQTTClient<doxid-class_n_r_p_m_q_t_t_client_1a497e55f608e977867e1fc4fe16c94ac0>`(:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>` clientParams);
		:target:`NRPMQTTClient<doxid-class_n_r_p_m_q_t_t_client_1a1b49655e8fa850e6825b467ed4223198>`();

		// methods
	
		virtual void :ref:`subscribe<doxid-class_n_r_p_m_q_t_t_client_1a75be6cf9468006ef13013a46c822b2ad>`(
			const std::string& address,
			const std::function<void(const std::string&)>& callback
		);
	
		virtual void :ref:`publish<doxid-class_n_r_p_m_q_t_t_client_1a9599c1a2cc3cf2ada78db21672f7d188>`(
			const std::string& address,
			const std::string& msg,
			bool retained = false
		);
	
		void :ref:`publishDirect<doxid-class_n_r_p_m_q_t_t_client_1af883c60142a36365180a8e4b5d55f56e>`(const std::string& address, const std::string& msg);
		virtual void :ref:`disconnect<doxid-class_n_r_p_m_q_t_t_client_1ad265f0b44d1891d6e8fe00c70ea36d4f>`();
		virtual bool :ref:`isConnected<doxid-class_n_r_p_m_q_t_t_client_1a411b7ab079c5cb4b4d522d45b547d694>`();
		virtual void :ref:`clearRetained<doxid-class_n_r_p_m_q_t_t_client_1a58efab96c732c59aa9e154b51620a2d5>`();
	};
.. _details-class_n_r_p_m_q_t_t_client:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Construction
------------

.. index:: pair: function; NRPMQTTClient
.. _doxid-class_n_r_p_m_q_t_t_client_1a497e55f608e977867e1fc4fe16c94ac0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	NRPMQTTClient(:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>` clientParams)

Constructor

Methods
-------

.. index:: pair: function; subscribe
.. _doxid-class_n_r_p_m_q_t_t_client_1a75be6cf9468006ef13013a46c822b2ad:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void subscribe(
		const std::string& address,
		const std::function<void(const std::string&)>& callback
	)

Subscribe to MQTT topic 'address' with callback function 'callback'.

.. index:: pair: function; publish
.. _doxid-class_n_r_p_m_q_t_t_client_1a9599c1a2cc3cf2ada78db21672f7d188:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void publish(
		const std::string& address,
		const std::string& msg,
		bool retained = false
	)

Publishes 'msg' to MQTT topic 'address'.

.. index:: pair: function; publishDirect
.. _doxid-class_n_r_p_m_q_t_t_client_1af883c60142a36365180a8e4b5d55f56e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void publishDirect(const std::string& address, const std::string& msg)

Publishes 'msg' directly to subscriber callbacks, without going through the MQTT broker. Only for testing.

.. index:: pair: function; disconnect
.. _doxid-class_n_r_p_m_q_t_t_client_1ad265f0b44d1891d6e8fe00c70ea36d4f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void disconnect()

Disconnects client from MQTT Broker.

.. index:: pair: function; isConnected
.. _doxid-class_n_r_p_m_q_t_t_client_1a411b7ab079c5cb4b4d522d45b547d694:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual bool isConnected()

Check connection status to broker.

.. index:: pair: function; clearRetained
.. _doxid-class_n_r_p_m_q_t_t_client_1a58efab96c732c59aa9e154b51620a2d5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void clearRetained()

Clear all topics with retain messages by sending an empty msg.