Qore jni Module 2.4.0
Loading...
Searching...
No Matches
BusyLightDataProvider::BusyLightDataProvider Class Reference

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

#include <BusyLightDataProvider.qc.dox.h>

Inheritance diagram for BusyLightDataProvider::BusyLightDataProvider:
MqttDataProvider::AbstractFunctionalMqttDataProvider MqttDataProvider::AbstractMqttDataProvider

Public Member Methods

 constructor (AbstractMqttDataProvider prev)
 Creates the object from another object of the same class.
 
 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
hash< DataProvider::DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

const ProviderInfo = ...
 Provider info.
 
const MESSAGE_BL_UPDATE = "update"
 BusyLight update message type.
 

Private Member Methods

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.
 

Detailed Description

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

Member Function Documentation

◆ getMessageTypesImpl()

hash< string, hash< DataProviderMessageInfo > > BusyLightDataProvider::BusyLightDataProvider::getMessageTypesImpl ( )
private

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

◆ sendMessageImpl()

BusyLightDataProvider::BusyLightDataProvider::sendMessageImpl ( string  message_id,
auto  msg,
*hash< auto >  send_message_options 
)
private

Sends a message from message-capable data providers.

Parameters
msgthe message to send
send_message_optionsthe options for sending the message

Member Data Documentation

◆ MESSAGE_BL_UPDATE

const BusyLightDataProvider::BusyLightDataProvider::MESSAGE_BL_UPDATE = "update"

BusyLight update message type.

Publishes an MQTT message to the given topic to update a BusyLight


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