![]() |
Open Lighting Architecture 0.10.9
|
OLA C++ API.
Classes | |
| class | auto_ptr |
| STL class. More... | |
| class | BaseClientWrapper |
| The base Client Wrapper class. More... | |
| class | ClientRDMAPIShim |
| class | ClientTypesFactory |
| Creates OlaPlugin types from protocol buffer objects. More... | |
| class | ConnectedDescriptor |
| A BidirectionalFileDescriptor that also generates notifications when closed. More... | |
| struct | DMXMetadata |
| Metadata that accompanies DMX packets. More... | |
| class | GenericClientWrapper |
| A templatized ClientWrapper. More... | |
| class | OlaClient |
| The callback based C++ client for OLA. More... | |
| class | OlaClientCore |
| The low level C++ API to olad. Clients shouldn't use this directly. Instead use ola::client::OlaClient. More... | |
| class | OlaDevice |
| Represents a device. More... | |
| class | OlaInputPort |
| An input port (receives DMX). More... | |
| class | OlaOutputPort |
| An Output Port (sends DMX). More... | |
| class | OlaPlugin |
| Represents a Plugin. More... | |
| class | OlaPort |
| The base class that represents a port. More... | |
| class | OlaUniverse |
| Represents a universe. More... | |
| struct | PluginState |
| The state of a plugin. This information can be used to detect conflicts between plugins. More... | |
| class | RDMAPIImplInterface |
| This is the interface for an RDMAPI implementation. More... | |
| struct | RDMMetadata |
| Metadata that accompanies RDM Responses. More... | |
| class | Result |
| Indicates the result of a OLA API call. More... | |
| class | RpcChannel |
| The RPC channel used to communicate between the client and the server. This implementation runs over a ConnectedDescriptor which means it can be used over TCP or pipes. More... | |
| class | RpcController |
| A RpcController object is passed every time an RPC is invoked and is used to indicate the success or failure of the RPC. More... | |
| class | SelectServer |
| A single threaded I/O event management system. More... | |
| struct | SendDMXArgs |
| Arguments passed to the SendDMX() method. More... | |
| struct | SendRDMArgs |
| Arguments used with OlaClient::RDMGet() and OlaClient::RDMSet() methods. More... | |
| class | StreamingClient |
| Send DMX512 data to olad. More... | |
| class | StreamingClientInterface |
| The interface for the StreamingClient class. More... | |
| class | string |
| STL class. More... | |
| class | TCPSocket |
| class | UID |
| Represents a RDM UID. More... | |
| class | UIDSet |
| Represents a set of RDM UIDs. More... | |
| class | vector |
| STL class. More... | |
Typedefs | |
| typedef SingleUseCallback2< void, const Result &, const std::vector< OlaPlugin > & > | PluginListCallback |
| Invoked when OlaClient::FetchPluginList() completes. | |
| typedef SingleUseCallback2< void, const Result &, const std::string & > | PluginDescriptionCallback |
| Invoked when OlaClient::FetchPluginDescription() completes. | |
| typedef SingleUseCallback2< void, const Result &, const PluginState & > | PluginStateCallback |
| Invoked when OlaClient::FetchPluginState() completes. | |
| typedef SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > | DeviceInfoCallback |
| Invoked when OlaClient::FetchDeviceInfo() completes. | |
| typedef SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > | CandidatePortsCallback |
| Invoked when OlaClient::FetchDeviceInfo() completes. | |
| typedef SingleUseCallback1< void, const Result & > | SetCallback |
| Invoked when an operation completes. | |
| typedef BaseCallback1< void, const Result & > | GeneralSetCallback |
| Invoked when an operation completes. | |
| typedef SingleUseCallback2< void, const Result &, const std::vector< OlaUniverse > & > | UniverseListCallback |
| Invoked when OlaClient::FetchUniverseList() completes. | |
| typedef SingleUseCallback2< void, const Result &, const OlaUniverse & > | UniverseInfoCallback |
| Invoked when OlaClient::FetchUniverseInfo() completes. | |
| typedef SingleUseCallback2< void, const Result &, const std::string & > | ConfigureDeviceCallback |
| Invoked when OlaClient::ConfigureDevice() completes. | |
| typedef SingleUseCallback2< void, const Result &, const ola::rdm::UIDSet & > | DiscoveryCallback |
| Invoked when OlaClient::RunDiscovery() completes. | |
| typedef SingleUseCallback3< void, const Result &, const DMXMetadata &, const DmxBuffer & > | DMXCallback |
| Called once when OlaClient::FetchDMX() completes. | |
| typedef Callback2< void, const DMXMetadata &, const DmxBuffer & > | RepeatableDMXCallback |
| Called when new DMX data arrives. | |
| typedef SingleUseCallback3< void, const Result &, const RDMMetadata &, const ola::rdm::RDMResponse * > | RDMCallback |
| Called when a RDM request completes. Used with OlaClient::RDMGet() and OlaClient::RDMSet(). | |
| typedef GenericClientWrapper< OlaClient > | OlaClientWrapper |
| A ClientWrapper that uses the OlaClient. | |
Enumerations | |
| enum | PatchAction { PATCH , UNPATCH } |
| The patch action, used with OlaClient::Patch() More... | |
| enum | RegisterAction { REGISTER , UNREGISTER } |
| The register action, used with OlaClient::RegisterUniverse() More... | |
| enum | PortDirection { INPUT_PORT , OUTPUT_PORT } |
| The port direction. More... | |
| enum | DiscoveryType { DISCOVERY_CACHED , DISCOVERY_INCREMENTAL , DISCOVERY_FULL } |
| The type of discovery to run with OlaClient::RunDiscovery(). More... | |
Functions | |
| TCPSocket * | ConnectToServer (unsigned short port) |
| typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&> ola::client::CandidatePortsCallback |
Invoked when OlaClient::FetchDeviceInfo() completes.
| typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::ConfigureDeviceCallback |
Invoked when OlaClient::ConfigureDevice() completes.
| result | the Result of the API call. |
| response | the raw data returned by the device. |
| typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&> ola::client::DeviceInfoCallback |
Invoked when OlaClient::FetchDeviceInfo() completes.
| typedef SingleUseCallback2<void, const Result&, const ola::rdm::UIDSet&> ola::client::DiscoveryCallback |
Invoked when OlaClient::RunDiscovery() completes.
| typedef SingleUseCallback3<void, const Result&, const DMXMetadata&, const DmxBuffer&> ola::client::DMXCallback |
Called once when OlaClient::FetchDMX() completes.
| result | the Result of the API call. |
| metadata | the DMXMetadata associated with the frame. |
| dmx | the DmxBuffer with the data. |
| typedef BaseCallback1<void, const Result&> ola::client::GeneralSetCallback |
Invoked when an operation completes.
| result | the Result of the API call. |
| typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::PluginDescriptionCallback |
Invoked when OlaClient::FetchPluginDescription() completes.
| result | the Result of the API call. |
| description | the plugin description. |
| typedef SingleUseCallback2<void, const Result&, const std::vector<OlaPlugin>&> ola::client::PluginListCallback |
Invoked when OlaClient::FetchPluginList() completes.
| typedef SingleUseCallback2<void, const Result&, const PluginState&> ola::client::PluginStateCallback |
Invoked when OlaClient::FetchPluginState() completes.
| result | the Result of the API call. |
| state | the PluginState object. |
| typedef SingleUseCallback3<void, const Result&, const RDMMetadata&, const ola::rdm::RDMResponse*> ola::client::RDMCallback |
Called when a RDM request completes. Used with OlaClient::RDMGet() and OlaClient::RDMSet().
| result | the Result of the API call. |
| metadata | the metadata for the response, including the rdm_response_code. |
| response | the RDM Response, or NULL if no response was received. |
| typedef Callback2<void, const DMXMetadata&, const DmxBuffer&> ola::client::RepeatableDMXCallback |
Called when new DMX data arrives.
| metadata | the DMXMetadata associated with the frame. |
| dmx | the DmxBuffer with the data. |
| typedef SingleUseCallback1<void, const Result&> ola::client::SetCallback |
Invoked when an operation completes.
| result | the Result of the API call. |
| typedef SingleUseCallback2<void, const Result&, const OlaUniverse&> ola::client::UniverseInfoCallback |
Invoked when OlaClient::FetchUniverseInfo() completes.
| result | the Result of the API call. |
| universe | the OlaUniverse object. |
| typedef SingleUseCallback2<void, const Result&, const std::vector<OlaUniverse>&> ola::client::UniverseListCallback |
Invoked when OlaClient::FetchUniverseList() completes.
| result | the Result of the API call. |
| universes | a vector of OlaUniverse objects |
The type of discovery to run with OlaClient::RunDiscovery().
| Enumerator | |
|---|---|
| DISCOVERY_CACHED | Fetch the cached list of UIDs |
| DISCOVERY_INCREMENTAL | Trigger incremental discovery |
| DISCOVERY_FULL | Trigger full discovery |
The patch action, used with OlaClient::Patch()
| Enumerator | |
|---|---|
| PATCH | Patch the port. |
| UNPATCH | Unpatch the port |
The register action, used with OlaClient::RegisterUniverse()
| Enumerator | |
|---|---|
| REGISTER | Register for the universe |
| UNREGISTER | Unregister from the universe |