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::rdm::RDMControllerInterface Class Referenceabstract

Detailed Description

The interface that can send RDMRequest.

Inheritance diagram for ola::rdm::RDMControllerInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void SendRDMRequest (RDMRequest *request, RDMCallback *on_complete)=0
 Send a RDM command. More...
 

Member Function Documentation

virtual void ola::rdm::RDMControllerInterface::SendRDMRequest ( RDMRequest request,
RDMCallback on_complete 
)
pure 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.

Implemented in ola::plugin::artnet::ArtNetNodeImplRDMWrapper, ola::BasicOutputPort, ola::plugin::usbpro::DmxTriWidget, ola::OutputPort, ola::plugin::usbpro::UsbProOutputPort, ola::plugin::usbpro::DmxterWidget, ola::plugin::usbpro::RobeWidget, ola::Universe, ola::plugin::usbpro::ArduinoWidget, ola::plugin::usbpro::EnttecPortImpl, ola::plugin::usbpro::RobeOutputPort, ola::plugin::spi::SPIOutput, ola::plugin::artnet::ArtNetOutputPort, ola::plugin::dummy::DummyPort, ola::plugin::usbpro::ArduinoRGBOutputPort, ola::plugin::usbpro::DmxTriOutputPort, ola::plugin::usbdmx::JaRuleOutputPort, ola::plugin::usbpro::DmxterOutputPort, ola::plugin::usbpro::EnttecPort, ola::usb::JaRulePortHandleImpl, ola::plugin::usbpro::RobeWidgetImpl, ola::plugin::usbpro::DmxTriWidgetImpl, ola::rdm::DimmerSubDevice, ola::rdm::QueueingRDMController, ola::rdm::AckTimerResponder, ola::rdm::DimmerResponder, ola::rdm::DiscoverableRDMControllerAdaptor, ola::plugin::spi::SPIOutputPort, ola::rdm::DimmerRootDevice, ola::rdm::NetworkResponder, ola::rdm::AdvancedDimmerResponder, ola::rdm::SensorResponder, ola::usb::JaRulePortHandle, ola::plugin::usbpro::ArduinoWidgetImpl, ola::plugin::usbpro::DmxterWidgetImpl, ola::rdm::MovingLightResponder, ola::rdm::DummyResponder, and ola::rdm::SubDeviceDispatcher.


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