/usr/include/olad/PluginAdaptor.h is in libola-dev 0.10.3.nojsmin-2+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | /*
* 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
*/
/**
* @file PluginAdaptor.h
* @brief Provides a wrapper for the DeviceManager and SelectServer objects so
* that the plugins can register devices and file handles for events
*/
#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:
/**
* @brief Create a new PluginAdaptor
* @param device_manager pointer to a DeviceManager object
* @param select_server pointer to the SelectServer object
* @param export_map pointer to the ExportMap object
* @param preferences_factory pointer to the PreferencesFactory object
* @param port_broker pointer to the PortBroker object
* @param instance_name the instance name of this OlaServer
*/
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
/**
* @brief Return the instance name for the OLA server
* @return a string which is the instance name
*/
const std::string InstanceName();
ExportMap *GetExportMap() const {
return m_export_map;
}
/**
* @brief Register a device
* @param device the device to register
* @return true on success, false on error
*/
bool RegisterDevice(class AbstractDevice *device) const;
/**
* @brief Unregister a device
* @param device the device to unregister
* @return true on success, false on error
*/
bool UnregisterDevice(class AbstractDevice *device) const;
/**
* @brief Create a new preferences container
* @return a Preferences object
*/
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_
|