ola::OlaClientCore Class Reference

Classes
struct	ack_args
struct	configure_device_args
struct	device_info_arg
struct	get_dmx_args
struct	plugin_description_arg
struct	plugin_list_arg
struct	plugin_state_arg
struct	rdm_pid_response_args
struct	rdm_response_args
struct	uid_list_args
struct	universe_info_args
struct	universe_list_args

Public Types
typedef Callback3< void, unsigned int, const DmxBuffer &, const string & >	DmxCallback
typedef Callback4< void, unsigned int, uint8_t, const DmxBuffer &, const string & >	DmxCallbackWithPriority

Public Member Functions
	OlaClientCore (ConnectedDescriptor *descriptor)
bool	Setup ()
bool	Stop ()
void	SetCloseHandler (ola::SingleUseCallback0< void > *callback)
bool	FetchPluginList (SingleUseCallback2< void, const vector< class OlaPlugin > &, const string & > *callback)
bool	FetchPluginDescription (ola_plugin_id plugin_id, SingleUseCallback2< void, const string &, const string & > *callback)
bool	FetchPluginState (ola_plugin_id plugin_id, OlaCallbackClient::PluginStateCallback *callback)
bool	FetchDeviceInfo (ola_plugin_id filter, SingleUseCallback2< void, const vector< class OlaDevice > &, const string & > *callback)
bool	FetchCandidatePorts (SingleUseCallback2< void, const vector< class OlaDevice > &, const string & > *callback)
bool	FetchCandidatePorts (unsigned int universe_id, SingleUseCallback2< void, const vector< class OlaDevice > &, const string & > *callback)
bool	ConfigureDevice (unsigned int device_alias, const string &msg, SingleUseCallback2< void, const string &, const string & > *callback)
bool	SetPortPriorityInherit (unsigned int device_alias, unsigned int port, PortDirection port_direction, SingleUseCallback1< void, const string & > *callback)
bool	SetPortPriorityOverride (unsigned int device_alias, unsigned int port, PortDirection port_direction, uint8_t value, SingleUseCallback1< void, const string & > *callback)
bool	FetchUniverseList (SingleUseCallback2< void, const vector< class OlaUniverse > &, const string & > *callback)
bool	FetchUniverseInfo (unsigned int universe, SingleUseCallback2< void, class OlaUniverse &, const string & > *callback)
bool	SetUniverseName (unsigned int uni, const string &name, SingleUseCallback1< void, const string & > *callback)
bool	SetUniverseMergeMode (unsigned int uni, OlaUniverse::merge_mode mode, SingleUseCallback1< void, const string & > *callback)
bool	Patch (unsigned int device_alias, unsigned int port, ola::PortDirection port_direction, ola::PatchAction action, unsigned int uni, SingleUseCallback1< void, const string & > *callback)
void	SetDmxCallback (DmxCallback *callback)
void	SetDmxCallback (DmxCallbackWithPriority *callback)
bool	RegisterUniverse (unsigned int universe, ola::RegisterAction register_action, SingleUseCallback1< void, const string & > *callback)
bool	SendDmx (unsigned int universe, const DmxBuffer &data, SingleUseCallback1< void, const string & > *callback)
bool	SendDmx (unsigned int universe, const DmxBuffer &data, Callback1< void, const string & > *callback)
bool	SendDmx (unsigned int universe, const DmxBuffer &data)
bool	FetchDmx (unsigned int universe, SingleUseCallback2< void, const DmxBuffer &, const string & > *callback)
bool	FetchUIDList (unsigned int universe, SingleUseCallback2< void, const ola::rdm::UIDSet &, const string & > *callback)
bool	RunDiscovery (unsigned int universe, bool full, ola::SingleUseCallback2< void, const ola::rdm::UIDSet &, const string & > *callback)
bool	SetSourceUID (const ola::rdm::UID &uid, ola::SingleUseCallback1< void, const string & > *callback)
bool	RDMGet (ola::rdm::RDMAPIImplInterface::rdm_callback *callback, unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length)
bool	RDMGet (ola::rdm::RDMAPIImplInterface::rdm_pid_callback *callback, unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length)
bool	RDMSet (ola::rdm::RDMAPIImplInterface::rdm_callback *callback, unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length)
bool	RDMSet (ola::rdm::RDMAPIImplInterface::rdm_pid_callback *callback, unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length)
bool	SendTimeCode (ola::SingleUseCallback1< void, const string & > *callback, const ola::timecode::TimeCode &timecode)
void	UpdateDmxData (::google::protobuf::RpcController *controller, const ola::proto::DmxData *request, ola::proto::Ack *response,::google::protobuf::Closure *done)
void	HandlePluginList (plugin_list_arg *args)
void	HandlePluginDescription (plugin_description_arg *args)
void	HandlePluginState (plugin_state_arg *args)
void	HandleDeviceInfo (device_info_arg *arg)
void	HandleDeviceConfig (configure_device_args *arg)
void	HandleAck (ack_args *args)
void	HandleUniverseList (universe_list_args *args)
void	HandleUniverseInfo (universe_info_args *args)
void	HandleGetDmx (get_dmx_args *args)
void	HandleUIDList (uid_list_args *args)
void	HandleRDM (rdm_response_args *args)
void	HandleRDMWithPID (rdm_pid_response_args *args)

Member Function Documentation

bool ola::OlaClientCore::FetchPluginState	(	ola_plugin_id	plugin_id,
		OlaCallbackClient::PluginStateCallback *	callback
	)

Fetch the state of a plugin. This returns the enabled state and the list of plugins this plugin conflicts with.

void ola::OlaClientCore::HandleRDMWithPID

(

rdm_pid_response_args *

args

)

Handle a RDM response, and pass the PID back to the client

bool ola::OlaClientCore::SendTimeCode	(	ola::SingleUseCallback1< void, const string & > *	callback,
		const ola::timecode::TimeCode &	timecode
	)

Send TimeCode data.

Parameters

callback	the Callback to invoke when this completes
timecode	The timecode data.

Returns

true on success, false on failure

void ola::OlaClientCore::SetCloseHandler

(

ola::SingleUseCallback0< void > *

callback

)

Set the close handler.

---

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

• ola/OlaClientCore.h
• ola/OlaClientCore.cpp