PluginAdaptor.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * PluginAdaptor.h
 * The provides operations on a ola_device.
 * Copyright (C) 2005 Simon Newton
 */

#ifndef INCLUDE_OLAD_PLUGINADAPTOR_H_
#define INCLUDE_OLAD_PLUGINADAPTOR_H_

#include <ola/Callback.h>
#include <ola/Clock.h>
#include <ola/ExportMap.h>
#include <ola/base/Macro.h>
#include <ola/io/SelectServerInterface.h>
#include <olad/OlaServer.h>

#include <string>

namespace ola {

class PluginAdaptor: public ola::io::SelectServerInterface {
 public:
  PluginAdaptor(class DeviceManager *device_manager,
                ola::io::SelectServerInterface *select_server,
                ExportMap *export_map,
                class PreferencesFactory *preferences_factory,
                class PortBrokerInterface *port_broker,
                const std::string *instance_name);

  // The following methods are part of the SelectServerInterface
  bool AddReadDescriptor(ola::io::ReadFileDescriptor *descriptor);

  bool AddReadDescriptor(ola::io::ConnectedDescriptor *descriptor,
                         bool delete_on_close = false);

  void RemoveReadDescriptor(ola::io::ReadFileDescriptor *descriptor);

  void RemoveReadDescriptor(ola::io::ConnectedDescriptor *descriptor);

  bool AddWriteDescriptor(ola::io::WriteFileDescriptor *descriptor);

  void RemoveWriteDescriptor(ola::io::WriteFileDescriptor *descriptor);

  ola::thread::timeout_id RegisterRepeatingTimeout(unsigned int ms,
                                                   Callback0<bool> *closure);

  ola::thread::timeout_id RegisterRepeatingTimeout(
      const TimeInterval &interval,
      Callback0<bool> *closure);

  ola::thread::timeout_id RegisterSingleTimeout(
      unsigned int ms,
      SingleUseCallback0<void> *closure);

  ola::thread::timeout_id RegisterSingleTimeout(
      const TimeInterval &interval,
      SingleUseCallback0<void> *closure);

  void RemoveTimeout(ola::thread::timeout_id id);

  void Execute(ola::BaseCallback0<void> *closure);

  const TimeStamp *WakeUpTime() const;

  // These are the extra bits for the plugins
  const std::string InstanceName() const;

  ExportMap *GetExportMap() const {
    return m_export_map;
  }

  bool RegisterDevice(class AbstractDevice *device) const;

  bool UnregisterDevice(class AbstractDevice *device) const;

  class Preferences *NewPreference(const std::string &name) const;
  class PortBrokerInterface *GetPortBroker() const {
    return m_port_broker;
  }

  void DrainCallbacks();

 private:
  DeviceManager *m_device_manager;
  ola::io::SelectServerInterface *m_ss;
  ExportMap *m_export_map;
  class PreferencesFactory *m_preferences_factory;
  class PortBrokerInterface *m_port_broker;
  const std::string *m_instance_name;

  DISALLOW_COPY_AND_ASSIGN(PluginAdaptor);
};
}  // namespace ola
#endif  // INCLUDE_OLAD_PLUGINADAPTOR_H_