Abstract base data provider for MQTT data provider classes providing MQTT messaging functionality. More...

#include <AbstractFunctionalMqttDataProvider.qc.dox.h>

Inheritance diagram for MqttDataProvider::AbstractFunctionalMqttDataProvider:

Public Member Methods
void	constructor (AbstractMqttDataProvider prev)
	Creates the object from another object of the same class.

void	constructor (soft< hash< auto > > options)
	Creates the object from constructor options.

void	observersReady ()
	Called when all observers have been added to the object.

void	stopEvents ()
	Called to stop generating events.

void	stop ()
	Disconnects the client and stops generating events.

void	start ()
	Connects and starts receiving messages.

void	connect ()
	Connects to the server if necessary.

void	messageReceived (Method method, soft< list< auto > > args)
	Qore callback for `IMqttMessageListener.messageArrived(java.lang.String topic, MqttMessage message)`

hash< string, hash< DataProviderMessageInfo > >	getEventTypesImpl ()
	Returns a hash of all supported event types.

hash< string, hash< DataProviderMessageInfo > >	getMessageTypesImpl ()
	Returns the description of an outbound message, if any.

void	sendMessageImpl (soft< hash< auto > > send_message_options, string message_id, auto msg)
	Sends a message from message-capable data providers.

Public Member Methods inherited from MqttDataProvider::AbstractMqttDataProvider
void	constructor ()
	Creates the object without any arguments for child classes.

void	constructor (AbstractMqttDataProvider prev)
	Creates the object from another object of the same class for child classes.

Public Attributes
const auto	ProviderInfo = ...
	Provider info.

const auto	ConstructorOptions = ...
	Constructor options.

const auto	EVENT_MQTT_MESSAGE = ...
	MQTT message event constant.

const auto	MESSAGE_MQTT_MESSAGE = ...
	MQTT message type.

Additional Inherited Members
Static Public Member Methods inherited from MqttDataProvider::AbstractMqttDataProvider
static hash< auto >	getClient (hash< auto > copts, soft< LoggerInterface > logger)
	Returns a client for the given options.

Private Attributes inherited from MqttDataProvider::AbstractMqttDataProvider
MqttClient	client
	The MQTT client itself.

MqttConnectOptions	opts
	Connection options.

string	topic
	Subscription topic filter.

int	qos
	Subscription QoS.

string	message_format
	Message payload format.

string	encoding
	Encoding for message_format "string".

Detailed Description

Abstract base data provider for MQTT data provider classes providing MQTT messaging functionality.

Member Function Documentation

◆ getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > MqttDataProvider::AbstractFunctionalMqttDataProvider::getEventTypesImpl ( )

Returns a hash of all supported event types.

Returns: a hash of all supported event types

Note: only called if the provider supports the observer pattern / event API

◆ getMessageTypesImpl()

hash< string, hash< DataProviderMessageInfo > > MqttDataProvider::AbstractFunctionalMqttDataProvider::getMessageTypesImpl ( )

Returns the description of an outbound message, if any.

Returns: the message type for this provider

Note: only called if the provider supports sending messages

◆ observersReady()

void MqttDataProvider::AbstractFunctionalMqttDataProvider::observersReady ( )

Called when all observers have been added to the object.

This method is meant to trigger event generation

◆ sendMessageImpl()

void MqttDataProvider::AbstractFunctionalMqttDataProvider::sendMessageImpl	(	soft< hash< auto > >	send_message_options,
		string	message_id,
		auto	msg
	)

Sends a message from message-capable data providers.

Parameters

msg	the message to send
send_message_options	the options for sending the message

◆ stopEvents()

void MqttDataProvider::AbstractFunctionalMqttDataProvider::stopEvents ( )

Called to stop generating events.

Stops polling for new events

Member Data Documentation

◆ MESSAGE_MQTT_MESSAGE

const auto MqttDataProvider::AbstractFunctionalMqttDataProvider::MESSAGE_MQTT_MESSAGE = ...

MQTT message type.

Publishes an MQTT message to the given topic

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

doxygen/qlib/MqttDataProvider/AbstractFunctionalMqttDataProvider.qc.dox.h

Public Member Methods

Public Attributes

Additional Inherited Members