Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::plugin::artnet::ArtNetNodeImplRDMWrapper Class Reference

Detailed Description

This glues the ArtNetNodeImpl together with the QueueingRDMController. The ArtNetNodeImpl takes a port id so we need this extra layer.

Inheritance diagram for ola::plugin::artnet::ArtNetNodeImplRDMWrapper:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::artnet::ArtNetNodeImplRDMWrapper:
Collaboration graph
[legend]

Public Member Functions

 ArtNetNodeImplRDMWrapper (ArtNetNodeImpl *impl, uint8_t port_id)
 
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
 Send a RDM command. More...
 
void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start a full discovery operation. More...
 
void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start an incremental discovery operation. More...
 

Member Function Documentation

void ola::plugin::artnet::ArtNetNodeImplRDMWrapper::RunFullDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
inlinevirtual

Start a full discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::artnet::ArtNetNodeImplRDMWrapper::RunIncrementalDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
inlinevirtual

Start an incremental discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::artnet::ArtNetNodeImplRDMWrapper::SendRDMRequest ( ola::rdm::RDMRequest request,
ola::rdm::RDMCallback on_complete 
)
inlinevirtual

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 file: