uniot::MQTTDevice Class Reference

#include <MQTTDevice.h>

Inheritance diagram for uniot::MQTTDevice:

Public Member Functions
	MQTTDevice ()
	Constructs a new MQTTDevice instance.
virtual	~MQTTDevice ()
	Virtual destructor that handles cleanup and unregistration from MQTTKit.
const String &	getDeviceId () const
	Gets the device identifier.
const String &	getOwnerId () const
	Gets the owner identifier.
const String &	subscribe (const String &topic)
	Subscribes to a specific MQTT topic.
const String &	subscribeDevice (const String &subTopic)
	Subscribes to a device-specific subtopic.
const String &	subscribeGroup (const String &groupId, const String &subTopic)
	Subscribes to a group-specific subtopic.
bool	unsubscribe (const String &topic)
	Unsubscribes from a specific topic.
virtual void	syncSubscriptions ()=0
	Reconstructs subscriptions after reconnection or credential changes.
void	unsubscribeFromAll ()
	Unsubscribes from all subscribed topics.
bool	isSubscribed (const String &topic)
	Checks if the device is subscribed to a given topic.
bool	isTopicMatch (const String &storedTopic, const String &incomingTopic) const
	Determines if a stored topic matches an incoming topic string using MQTT wildcards.
void	publish (const String &topic, const Bytes &payload, bool retained=false, bool sign=false)
	Publishes a message to a specific topic.
void	publishDevice (const String &subTopic, const Bytes &payload, bool retained=false, bool sign=false)
	Publishes a message to a device-specific subtopic.
void	publishGroup (const String &groupId, const String &subTopic, const Bytes &payload, bool retained=false, bool sign=false)
	Publishes a message to a group-specific subtopic.
void	publishEmptyDevice (const String &subTopic)
	Publishes an empty message to a device-specific subtopic with retained flag set.

Protected Member Functions
virtual void	handle (const String &topic, const Bytes &payload)=0
	Handles incoming MQTT messages.

Friends
class	MQTTKit

Constructor & Destructor Documentation

MQTTDevice()

uniot::MQTTDevice::MQTTDevice ( )

inline

Constructs a new MQTTDevice instance.

~MQTTDevice()

uniot::MQTTDevice::~MQTTDevice ( )

virtual

Virtual destructor that handles cleanup and unregistration from MQTTKit.

Member Function Documentation

getDeviceId()

const String & uniot::MQTTDevice::getDeviceId

(

)

const

Gets the device identifier.

Return values

deviceId&	A reference to the device ID string
sEmptyString	Empty string if not connected to a kit.

getOwnerId()

const String & uniot::MQTTDevice::getOwnerId

(

)

const

Gets the owner identifier.

Return values

ownerId&	A reference to the owner ID string
sEmptyString	Empty string if not connected to a kit.

handle()

virtual void uniot::MQTTDevice::handle ( const String & topic, const Bytes & payload )

protectedpure virtual

Handles incoming MQTT messages.

Parameters

topic	The topic the message was received on.
payload	The message payload.

Implementing classes must override this to process incoming messages.

Implemented in uniot::CallbackMQTTDevice, uniot::LispDevice, and uniot::TopDevice.

isSubscribed()

bool uniot::MQTTDevice::isSubscribed

(

const String &

topic

)

Checks if the device is subscribed to a given topic.

Parameters

topic

The topic to check for subscription.

Return values

true	The device is subscribed to the topic.
false	The device is not subscribed to the topic.

isTopicMatch()

bool uniot::MQTTDevice::isTopicMatch	(	const String &	storedTopic,
		const String &	incomingTopic ) const

Determines if a stored topic matches an incoming topic string using MQTT wildcards.

Implements MQTT topic matching with support for + (single-level) and # (multi-level) wildcards.

Parameters

storedTopic	The topic string with possible wildcards (+ or #) the device is subscribed to.
incomingTopic	The concrete topic string from an incoming message.

Return values

true	The topics match.
false	The topics do not match.

publish()

void uniot::MQTTDevice::publish	(	const String &	topic,
		const Bytes &	payload,
		bool	retained = false,
		bool	sign = false )

Publishes a message to a specific topic.

Parameters

topic	The complete topic to publish to.
payload	The message payload.
retained	Whether the message should be retained by the broker.
sign	Whether to cryptographically sign the message.

publishDevice()

void uniot::MQTTDevice::publishDevice	(	const String &	subTopic,
		const Bytes &	payload,
		bool	retained = false,
		bool	sign = false )

Publishes a message to a device-specific subtopic.

Parameters

subTopic	The subtopic to append to the device base path.
payload	The message payload.
retained	Whether the message should be retained by the broker.
sign	Whether to cryptographically sign the message.

publishEmptyDevice()

void uniot::MQTTDevice::publishEmptyDevice

(

const String &

subTopic

)

Publishes an empty message to a device-specific subtopic with retained flag set.

Parameters

subTopic

The subtopic to append to the device base path.

This is commonly used to clear retained messages from the broker.

publishGroup()

void uniot::MQTTDevice::publishGroup	(	const String &	groupId,
		const String &	subTopic,
		const Bytes &	payload,
		bool	retained = false,
		bool	sign = false )

Publishes a message to a group-specific subtopic.

Parameters

groupId	The identifier of the group to publish to.
subTopic	The subtopic to append to the group base path.
payload	The message payload.
retained	Whether the message should be retained by the broker.
sign	Whether to cryptographically sign the message.

subscribe()

const String & uniot::MQTTDevice::subscribe

(

const String &

topic

)

Subscribes to a specific MQTT topic.

Parameters

topic

The complete MQTT topic string to subscribe to.

Return values

String&

Reference to the stored topic string.

subscribeDevice()

const String & uniot::MQTTDevice::subscribeDevice

(

const String &

subTopic

)

Subscribes to a device-specific subtopic.

Parameters

subTopic

The subtopic to append to the device base path.

Return values

String&	A reference to the stored topic string.
sEmptyString	Empty string if not connected to a kit.

subscribeGroup()

const String & uniot::MQTTDevice::subscribeGroup	(	const String &	groupId,
		const String &	subTopic )

Subscribes to a group-specific subtopic.

Parameters

groupId	The identifier of the group to subscribe to.
subTopic	The subtopic to append to the group base path.

Return values

String&	A reference to the stored topic string.
sEmptyString	Empty string if not connected to a kit.

syncSubscriptions()

virtual void uniot::MQTTDevice::syncSubscriptions ( )

pure virtual

Reconstructs subscriptions after reconnection or credential changes.

Implementing classes should override this to set up all required subscriptions.

Note

Subscriptions that depend on credentials should be reconstructed here

Implemented in uniot::LispDevice, and uniot::TopDevice.

unsubscribe()

bool uniot::MQTTDevice::unsubscribe

(

const String &

topic

)

Unsubscribes from a specific topic.

Parameters

topic

The topic to unsubscribe from.

Return values

true	Successfully unsubscribed.
false	Failed to unsubscribe (e.g., not subscribed).

unsubscribeFromAll()

void uniot::MQTTDevice::unsubscribeFromAll

(

)

Unsubscribes from all subscribed topics.

Friends And Related Symbol Documentation

MQTTKit

friend class MQTTKit

friend

---

The documentation for this class was generated from the following files:

• MQTTDevice.h
• MQTTDevice.cpp