OlaClient.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * OlaClient.h
 * This is the main client API to OLA.
 * Copyright (C) 2010 Simon Newton
 */

#ifndef INCLUDE_OLA_CLIENT_OLACLIENT_H_
#define INCLUDE_OLA_CLIENT_OLACLIENT_H_

#include <ola/DmxBuffer.h>
#include <ola/client/CallbackTypes.h>
#include <ola/client/ClientArgs.h>
#include <ola/client/ClientTypes.h>
#include <ola/base/Macro.h>
#include <ola/io/Descriptor.h>
#include <ola/plugin_id.h>
#include <ola/rdm/UID.h>
#include <ola/rdm/UIDSet.h>
#include <ola/timecode/TimeCode.h>

#include <memory>
#include <string>

namespace ola {
namespace client {

class OlaClient {
 public:
 explicit OlaClient(ola::io::ConnectedDescriptor *descriptor);
 ~OlaClient();

 /*
 * @brief Setup this client.
 * @returns true on success, false on failure
 */
 bool Setup();

 /*
 * @brief Close the ola connection.
 * @return true on sucess, false on failure
 */
 bool Stop();

 void SetCloseHandler(ola::SingleUseCallback0<void> *callback);

 void SetDMXCallback(RepeatableDMXCallback *callback);

 void ReloadPlugins(SetCallback *callback);

 void FetchPluginList(PluginListCallback *callback);

 void FetchPluginDescription(ola_plugin_id plugin_id,
 PluginDescriptionCallback *callback);

 void FetchPluginState(ola_plugin_id plugin_id,
 PluginStateCallback *callback);

 void FetchDeviceInfo(ola_plugin_id plugin_filter,
 DeviceInfoCallback *callback);

 void FetchCandidatePorts(CandidatePortsCallback *callback);

 void FetchCandidatePorts(unsigned int universe_id,
 CandidatePortsCallback *callback);

 void SetPluginState(ola_plugin_id plugin_id,
 bool state,
 SetCallback *callback);

 void ConfigureDevice(unsigned int device_alias,
 const std::string &msg,
 ConfigureDeviceCallback *callback);

 void SetPortPriorityInherit(unsigned int device_alias,
 unsigned int port,
 PortDirection port_direction,
 SetCallback *callback);

 void SetPortPriorityOverride(unsigned int device_alias,
 unsigned int port,
 PortDirection port_direction,
 uint8_t value,
 SetCallback *callback);

 void FetchUniverseList(UniverseListCallback *callback);

 void FetchUniverseInfo(unsigned int universe,
 UniverseInfoCallback *callback);

 void SetUniverseName(unsigned int universe,
 const std::string &name,
 SetCallback *callback);

 void SetUniverseMergeMode(unsigned int universe,
 OlaUniverse::merge_mode mode,
 SetCallback *callback);

 void Patch(unsigned int device_alias,
 unsigned int port,
 PortDirection port_direction,
 PatchAction action,
 unsigned int universe,
 SetCallback *callback);

 void RegisterUniverse(unsigned int universe,
 RegisterAction register_action,
 SetCallback *callback);

 void SendDMX(unsigned int universe,
 const DmxBuffer &data,
 const SendDMXArgs &args);

 void FetchDMX(unsigned int universe, DMXCallback *callback);

 void RunDiscovery(unsigned int universe,
 DiscoveryType discovery_type,
 DiscoveryCallback *callback);

 void SetSourceUID(const ola::rdm::UID &uid, SetCallback *callback);

 void RDMGet(unsigned int universe,
 const ola::rdm::UID &uid,
 uint16_t sub_device,
 uint16_t pid,
 const uint8_t *data,
 unsigned int data_length,
 const SendRDMArgs& args);

 void RDMSet(unsigned int universe,
 const ola::rdm::UID &uid,
 uint16_t sub_device,
 uint16_t pid,
 const uint8_t *data,
 unsigned int data_length,
 const SendRDMArgs& args);

 void SendTimeCode(const ola::timecode::TimeCode &timecode,
 SetCallback *callback);

 private:
 std::auto_ptr<class OlaClientCore> m_core;

 DISALLOW_COPY_AND_ASSIGN(OlaClient);
};
} // namespace client
} // namespace ola
#endif // INCLUDE_OLA_CLIENT_OLACLIENT_H_