Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Member Functions | List of all members
ola::rdm::SubDeviceDispatcher Class Reference
Inheritance diagram for ola::rdm::SubDeviceDispatcher:
Inheritance graph
[legend]
Collaboration diagram for ola::rdm::SubDeviceDispatcher:
Collaboration graph
[legend]

Public Member Functions

void AddSubDevice (uint16_t sub_device_number, ola::rdm::RDMControllerInterface *device)
 
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Send a RDM command. More...
 

Member Function Documentation

void ola::rdm::SubDeviceDispatcher::AddSubDevice ( uint16_t  sub_device_number,
ola::rdm::RDMControllerInterface device 
)

Add or remove a sub device. Ownership of the device is not transferred.

void ola::rdm::SubDeviceDispatcher::SendRDMRequest ( ola::rdm::RDMRequest request,
ola::rdm::RDMCallback on_complete 
)
virtual

Send a RDM command.

Parameters
requestthe RDMRequest, ownership is transferred.
on_completeThe callback to run when the request completes.

Implementors much ensure that the callback is always run at some point. In other words, there must be no way that a request can be dropped in such a way that the callback is never run. Doing so will either block all subsequent requests, or leak memory depending on the implementation.

Also the implementor of this class may want to re-write the transaction #, and possibly the UID (changing src UIDs isn't addressed by the RDM spec).

The RDMRequest may be a DISCOVERY_COMMAND, if the implementation does not support DISCOVERY_COMMANDs then the callback should be run with ola::rdm::RDM_PLUGIN_DISCOVERY_NOT_SUPPORTED.

Implements ola::rdm::RDMControllerInterface.


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