MqttDataProvider::MqttDataProvider Class Reference

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
void	constructor (soft< hash< auto > > options)
	Creates the object from constructor options.
hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.
soft< list< hash< DataProvider::DataProviderSummaryInfo > > >	getChildProviderSummaryInfo ()
	Return data provider summary info.
soft< list< string > >	getChildProviderNamesImpl ()
	Returns a list of child data provider names, if any.
soft< DataProvider::AbstractDataProvider >	getChildProviderImpl (string name)
	Returns the given child provider or nothing if the given child is unknown.
Public Member Methods inherited from MqttDataProvider::AbstractFunctionalMqttDataProvider
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	ChildMap = ...
	Child data provider map.
Public Attributes inherited from MqttDataProvider::AbstractFunctionalMqttDataProvider
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

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

Member Function Documentation

getChildProviderImpl()

soft< DataProvider::AbstractDataProvider > MqttDataProvider::MqttDataProvider::getChildProviderImpl

(

string

name

)

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

Returns

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

See also

getChildProviderEx()

getChildProviderNamesImpl()

soft< list< string > > MqttDataProvider::MqttDataProvider::getChildProviderNamesImpl

(

)

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

Returns

a list of child data provider names, if any

---

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

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