Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Typedefs | Enumerations | Functions
ola::client Namespace Reference

Detailed Description

OLA C++ API.

Classes

class  BaseClientWrapper
 The base Client Wrapper class. More...
 
class  ClientRDMAPIShim
 
class  ClientTypesFactory
 Creates OlaPlugin types from protocol buffer objects. 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...
 
struct  RDMMetadata
 Metadata that accompanies RDM Responses. More...
 
class  Result
 Indicates the result of a OLA API call. 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...
 

Typedefs

typedef SingleUseCallback2
< void, const Result &, const
std::vector< OlaPlugin > & > 
PluginListCallback
 Invoked when OlaClient::FetchPluginList() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
std::string & > 
PluginDescriptionCallback
 Invoked when OlaClient::FetchPluginDescription() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
PluginState & > 
PluginStateCallback
 Invoked when OlaClient::FetchPluginState() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
std::vector< OlaDevice > & > 
DeviceInfoCallback
 Invoked when OlaClient::FetchDeviceInfo() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
std::vector< OlaDevice > & > 
CandidatePortsCallback
 Invoked when OlaClient::FetchDeviceInfo() completes. More...
 
typedef SingleUseCallback1
< void, const Result & > 
SetCallback
 Invoked when an operation completes. More...
 
typedef BaseCallback1< void,
const Result & > 
GeneralSetCallback
 Invoked when an operation completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
std::vector< OlaUniverse > & > 
UniverseListCallback
 Invoked when OlaClient::FetchUniverseList() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
OlaUniverse & > 
UniverseInfoCallback
 Invoked when OlaClient::FetchUniverseInfo() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
std::string & > 
ConfigureDeviceCallback
 Invoked when OlaClient::ConfigureDevice() completes. More...
 
typedef SingleUseCallback2
< void, const Result &, const
ola::rdm::UIDSet & > 
DiscoveryCallback
 Invoked when OlaClient::RunDiscovery() completes. More...
 
typedef SingleUseCallback3
< void, const Result &, const
DMXMetadata &, const DmxBuffer & > 
DMXCallback
 Called once when OlaClient::FetchDMX() completes. More...
 
typedef Callback2< void, const
DMXMetadata &, const DmxBuffer & > 
RepeatableDMXCallback
 Called when new DMX data arrives. More...
 
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(). More...
 
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

TCPSocketConnectToServer (unsigned short port)
 

Typedef Documentation

typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&> ola::client::CandidatePortsCallback

Invoked when OlaClient::FetchDeviceInfo() completes.

Parameters
resultthe Result of the API call.
devicesa vector of OlaDevice objects.
typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::ConfigureDeviceCallback

Invoked when OlaClient::ConfigureDevice() completes.

Parameters
resultthe Result of the API call.
responsethe raw data returned by the device.
typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&> ola::client::DeviceInfoCallback

Invoked when OlaClient::FetchDeviceInfo() completes.

Parameters
resultthe Result of the API call.
devicesa vector of OlaDevice objects.

Invoked when OlaClient::RunDiscovery() completes.

Parameters
resultthe Result of the API call.
uidsthe UIDSet containing the UIDs for the specified universe. The UIDSet will be empty if the request failed.

Called once when OlaClient::FetchDMX() completes.

Parameters
resultthe Result of the API call.
metadatathe DMXMetadata associated with the frame.
dmxthe DmxBuffer with the data.

Invoked when an operation completes.

Parameters
resultthe Result of the API call.
typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::PluginDescriptionCallback

Invoked when OlaClient::FetchPluginDescription() completes.

Parameters
resultthe Result of the API call.
descriptionthe plugin description.
typedef SingleUseCallback2<void, const Result&, const std::vector<OlaPlugin>&> ola::client::PluginListCallback

Invoked when OlaClient::FetchPluginList() completes.

Parameters
resultthe Result of the API call.
pluginsa vector of OlaPlugin objects.

Invoked when OlaClient::FetchPluginState() completes.

Parameters
resultthe Result of the API call.
statethe PluginState object.

Called when a RDM request completes. Used with OlaClient::RDMGet() and OlaClient::RDMSet().

Parameters
resultthe Result of the API call.
metadatathe metadata for the response, including the rdm_response_code.
responsethe RDM Response, or NULL if no response was received.

Called when new DMX data arrives.

Parameters
metadatathe DMXMetadata associated with the frame.
dmxthe DmxBuffer with the data.

Invoked when an operation completes.

Parameters
resultthe Result of the API call.

Invoked when OlaClient::FetchUniverseInfo() completes.

Parameters
resultthe Result of the API call.
universethe OlaUniverse object.
typedef SingleUseCallback2<void, const Result&, const std::vector<OlaUniverse>&> ola::client::UniverseListCallback

Invoked when OlaClient::FetchUniverseList() completes.

Parameters
resultthe Result of the API call.
universesa vector of OlaUniverse objects

Enumeration Type Documentation

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 port direction.

Enumerator
INPUT_PORT 

An input port which receives DMX data

OUTPUT_PORT 

An output port which sends DMX data

The register action, used with OlaClient::RegisterUniverse()

Enumerator
REGISTER 

Register for the universe

UNREGISTER 

Unregister from the universe