Open Lighting Architecture: ola::client Namespace Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions
ola::client Namespace Reference

## Detailed Description

OLA C++ API.

## Classes
struct | SendDMXArgs
| Arguments passed to the SendDMX() method. More...
struct | SendRDMArgs
| Arguments used with OlaClient::RDMGet() and OlaClient::RDMSet() methods. More...
class | ClientRDMAPIShim
class | OlaPlugin
| Represents a Plugin. More...
struct | PluginState
| The state of a plugin. This information can be used to detect conflicts between plugins. More...
class | OlaPort
| The base class that represents a port. More...
class | OlaInputPort
| An input port (receives DMX). More...
class | OlaOutputPort
| An Output Port (sends DMX). More...
class | OlaDevice
| Represents a device. More...
class | OlaUniverse
| Represents a universe. More...
struct | DMXMetadata
| Metadata that accompanies DMX packets. More...
struct | RDMMetadata
| Metadata that accompanies RDM Responses. More...
class | BaseClientWrapper
| The base Client Wrapper class. More...
class | GenericClientWrapper
| A templatized ClientWrapper. More...
class | OlaClient
| The callback based C++ client for OLA. More...
class | Result
| Indicates the result of a OLA API call. More...
class | StreamingClientInterface
| The interface for the StreamingClient class. More...
class | StreamingClient
| Send DMX512 data to olad. More...
class | ClientTypesFactory
| Creates OlaPlugin types from protocol buffer objects. More...
class | OlaClientCore
| The low level C++ API to olad. Clients shouldn't use this directly. Instead use ola::client::OlaClient. More...
class | TCPSocket
class | string
| STL class. More...
class | vector
| STL class. More...
class | RDMAPIImplInterface
| This is the interface for an RDMAPI implementation. More...
class | ConnectedDescriptor
| A BidirectionalFileDescriptor that also generates notifications when closed. More...
class | UID
| Represents a RDM UID. More...
class | UIDSet
| Represents a set of RDM UIDs. 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 | auto_ptr
| STL class. More...
class | SelectServer
| A single threaded I/O event management system. 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 Documentation

## ◆ CandidatePortsCallback

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

Invoked when OlaClient::FetchDeviceInfo() completes.

Parameters

  result | the Result of the API call.
  devices | a vector of OlaDevice objects.

## ◆ ConfigureDeviceCallback

typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::ConfigureDeviceCallback

Invoked when OlaClient::ConfigureDevice() completes.

Parameters

  result | the Result of the API call.
  response | the raw data returned by the device.

## ◆ DeviceInfoCallback

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

Invoked when OlaClient::FetchDeviceInfo() completes.

Parameters

  result | the Result of the API call.
  devices | a vector of OlaDevice objects.

## ◆ DiscoveryCallback

typedef SingleUseCallback2<void, const Result&, const ola::rdm::UIDSet&> ola::client::DiscoveryCallback

Invoked when OlaClient::RunDiscovery() completes.

Parameters

  result | the Result of the API call.
  uids | the UIDSet containing the UIDs for the specified universe. The UIDSet will be empty if the request failed.

## ◆ DMXCallback

typedef SingleUseCallback3<void, const Result&, const DMXMetadata&, const DmxBuffer&> ola::client::DMXCallback

Called once when OlaClient::FetchDMX() completes.

Parameters

  result | the Result of the API call.
  metadata | the DMXMetadata associated with the frame.
  dmx | the DmxBuffer with the data.

## ◆ GeneralSetCallback

typedef BaseCallback1<void, const Result&> ola::client::GeneralSetCallback

Invoked when an operation completes.

Parameters

  result | the Result of the API call.

## ◆ PluginDescriptionCallback

typedef SingleUseCallback2<void, const Result&, const std::string&> ola::client::PluginDescriptionCallback

Invoked when OlaClient::FetchPluginDescription() completes.

Parameters

  result | the Result of the API call.
  description | the plugin description.

## ◆ PluginListCallback

typedef SingleUseCallback2<void, const Result&, const std::vector<OlaPlugin>&> ola::client::PluginListCallback

Invoked when OlaClient::FetchPluginList() completes.

Parameters

  result | the Result of the API call.
  plugins | a vector of OlaPlugin objects.

## ◆ PluginStateCallback

typedef SingleUseCallback2<void, const Result&, const PluginState&> ola::client::PluginStateCallback

Invoked when OlaClient::FetchPluginState() completes.

Parameters

  result | the Result of the API call.
  state | the PluginState object.

## ◆ RDMCallback

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().

Parameters

  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.

## ◆ RepeatableDMXCallback

typedef Callback2<void, const DMXMetadata&, const DmxBuffer&> ola::client::RepeatableDMXCallback

Called when new DMX data arrives.

Parameters

  metadata | the DMXMetadata associated with the frame.
  dmx | the DmxBuffer with the data.

## ◆ SetCallback

typedef SingleUseCallback1<void, const Result&> ola::client::SetCallback

Invoked when an operation completes.

Parameters

  result | the Result of the API call.

## ◆ UniverseInfoCallback

typedef SingleUseCallback2<void, const Result&, const OlaUniverse&> ola::client::UniverseInfoCallback

Invoked when OlaClient::FetchUniverseInfo() completes.

Parameters

  result | the Result of the API call.
  universe | the OlaUniverse object.

## ◆ UniverseListCallback

typedef SingleUseCallback2<void, const Result&, const std::vector<OlaUniverse>&> ola::client::UniverseListCallback

Invoked when OlaClient::FetchUniverseList() completes.

Parameters

  result | the Result of the API call.
  universes | a vector of OlaUniverse objects

## Enumeration Type Documentation

## ◆ DiscoveryType

enum ola::client::DiscoveryType

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

## ◆ PatchAction

enum ola::client::PatchAction

The patch action, used with OlaClient::Patch().

Enumerator
PATCH | Patch the port.
UNPATCH | Unpatch the port

## ◆ PortDirection

enum ola::client::PortDirection

The port direction.

Enumerator
INPUT_PORT | An input port which receives DMX data
OUTPUT_PORT | An output port which sends DMX data

## ◆ RegisterAction

enum ola::client::RegisterAction

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

Enumerator
REGISTER | Register for the universe
UNREGISTER | Unregister from the universe