Event- and message-based data provider for MQTT client-side events. More...

#include <MqttDataProvider.qc.dox.h>

Inheritance diagram for MqttDataProvider::MqttDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.

hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

*list< hash< DataProvider::DataProviderSummaryInfo > >	getChildProviderSummaryInfo ()
	Return data provider summary info.

Public Member Methods inherited from MqttDataProvider::AbstractFunctionalMqttDataProvider
	constructor (AbstractMqttDataProvider prev)
	Creates the object from another object of the same class.

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

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

	stopEvents ()
	Called to stop generating events.

Public Attributes
const	ProviderInfo = ...
	Provider info.

const	ChildMap = ...
	Child data provider map.

Public Attributes inherited from MqttDataProvider::AbstractFunctionalMqttDataProvider
const	ProviderInfo = ...
	Provider info.

const	ConstructorOptions = ...
	Constructor options.

const	EVENT_MQTT_MESSAGE = "mqtt-message-event"
	MQTT message event constant.

const	MESSAGE_MQTT_MESSAGE = "message"
	MQTT message type.

Private Member Methods
*list< string >	getChildProviderNamesImpl ()
	Returns a list of child data provider names, if any.

*DataProvider::AbstractDataProvider	getChildProviderImpl (string name)
	Returns the given child provider or nothing if the given child is unknown.

Private Member Methods inherited from MqttDataProvider::AbstractFunctionalMqttDataProvider
	stop ()
	Disconnects the client and stops generating events.

	start ()
	Connects and starts receiving messages.

	connect ()
	Connects to the server if necessary.

	messageReceived (Method method, *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.

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

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

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

Additional Inherited Members
Static Public Member Methods inherited from MqttDataProvider::AbstractMqttDataProvider
static hash< auto >	getClient (hash< auto > copts)
	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

Event- and message-based data provider for MQTT client-side events.

Member Function Documentation

*DataProvider::AbstractDataProvider MqttDataProvider::MqttDataProvider::getChildProviderImpl ( string name )

private

Returns the given child provider or nothing if the given child is unknown.

*list< string > MqttDataProvider::MqttDataProvider::getChildProviderNamesImpl ( )

private

Returns a list of child data provider names, if any.

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