Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PluginAdaptor.h
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 2 of the License, or
5  * (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU Library General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15  *
16  * PluginAdaptor.h
17  * The provides operations on a ola_device.
18  * Copyright (C) 2005 Simon Newton
19  */
20 
27 #ifndef INCLUDE_OLAD_PLUGINADAPTOR_H_
28 #define INCLUDE_OLAD_PLUGINADAPTOR_H_
29 
30 #include <ola/Callback.h>
31 #include <ola/Clock.h>
32 #include <ola/ExportMap.h>
33 #include <ola/base/Macro.h>
34 #include <ola/io/SelectServerInterface.h>
35 #include <olad/OlaServer.h>
36 
37 #include <string>
38 
39 namespace ola {
40 
42  public:
52  PluginAdaptor(class DeviceManager *device_manager,
53  ola::io::SelectServerInterface *select_server,
54  ExportMap *export_map,
55  class PreferencesFactory *preferences_factory,
56  class PortBrokerInterface *port_broker,
57  const std::string *instance_name);
58 
59  // The following methods are part of the SelectServerInterface
61 
63  bool delete_on_close = false);
64 
66 
68 
70 
72 
74  Callback0<bool> *closure);
75 
77  const TimeInterval &interval,
78  Callback0<bool> *closure);
79 
81  unsigned int ms,
82  SingleUseCallback0<void> *closure);
83 
85  const TimeInterval &interval,
86  SingleUseCallback0<void> *closure);
87 
89 
90  void Execute(ola::BaseCallback0<void> *closure);
91 
92  const TimeStamp *WakeUpTime() const;
93 
94  // These are the extra bits for the plugins
99  const std::string InstanceName() const;
100 
101  ExportMap *GetExportMap() const {
102  return m_export_map;
103  }
104 
110  bool RegisterDevice(class AbstractDevice *device) const;
111 
117  bool UnregisterDevice(class AbstractDevice *device) const;
118 
123  class Preferences *NewPreference(const std::string &name) const;
124  class PortBrokerInterface *GetPortBroker() const {
125  return m_port_broker;
126  }
127 
128  void DrainCallbacks();
129 
130  private:
131  DeviceManager *m_device_manager;
133  ExportMap *m_export_map;
134  class PreferencesFactory *m_preferences_factory;
135  class PortBrokerInterface *m_port_broker;
136  const std::string *m_instance_name;
137 
139 };
140 } // namespace ola
141 #endif // INCLUDE_OLAD_PLUGINADAPTOR_H_
A time interval, with usecond accuracy.
Definition: Clock.h:130
Definition: PortBroker.h:40
A 0 arg, single use callback that returns void.
Definition: Callback.h:157
bool UnregisterDevice(class AbstractDevice *device) const
Unregister a device.
Definition: PluginAdaptor.cpp:120
Definition: Preferences.h:345
#define DISALLOW_COPY_AND_ASSIGN(TypeName)
Creates dummy copy constructor and assignment operator declarations.
Definition: Macro.h:44
A container for the exported variables.
Definition: ExportMap.h:324
A BidirectionalFileDescriptor that also generates notifications when closed.
Definition: Descriptor.h:282
A 0 argument callback which can be called multiple times.
Definition: Callback.h:129
Export variables on the http server.
ola::thread::timeout_id RegisterRepeatingTimeout(unsigned int ms, Callback0< bool > *closure)
Execute a callback periodically.
Definition: PluginAdaptor.cpp:80
void * timeout_id
A timeout handle which can later be used to cancel a timeout.
Definition: SchedulerInterface.h:34
The interface for a Device.
Definition: Device.h:44
Keeps track of OLA's devices.
Definition: DeviceManager.h:61
void RemoveWriteDescriptor(ola::io::WriteFileDescriptor *descriptor)
Remove a WriteFileDescriptor for write-events.
Definition: PluginAdaptor.cpp:75
bool RegisterDevice(class AbstractDevice *device) const
Register a device.
Definition: PluginAdaptor.cpp:116
The interface for the SelectServer.
Definition: SelectServerInterface.h:42
Definition: PluginAdaptor.h:41
const std::string InstanceName() const
Return the instance name for the OLA server.
Definition: PluginAdaptor.cpp:132
ola::thread::timeout_id RegisterSingleTimeout(unsigned int ms, SingleUseCallback0< void > *closure)
Execute a callback after a certain time interval.
Definition: PluginAdaptor.cpp:92
Represents a file descriptor that supports reading data.
Definition: Descriptor.h:140
void DrainCallbacks()
Run all callbacks until there are none left.
Definition: PluginAdaptor.cpp:112
Definition: Preferences.h:147
Helper macros.
void RemoveTimeout(ola::thread::timeout_id id)
Cancel an existing timeout.
Definition: PluginAdaptor.cpp:104
bool AddReadDescriptor(ola::io::ReadFileDescriptor *descriptor)
Register a ReadFileDescriptor for read-events.
Definition: PluginAdaptor.cpp:49
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
void Execute(ola::BaseCallback0< void > *closure)
Execute the supplied callback at some point in the future.
Definition: PluginAdaptor.cpp:108
Represents a point in time with microsecond accuracy.
Definition: Clock.h:183
Represents a file descriptor that supports writing data.
Definition: Descriptor.h:170
const TimeStamp * WakeUpTime() const
The time when this SelectServer was woken up.
Definition: PluginAdaptor.cpp:128
bool AddWriteDescriptor(ola::io::WriteFileDescriptor *descriptor)
Register a WriteFileDescriptor for write-events.
Definition: PluginAdaptor.cpp:70
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)
Create a new PluginAdaptor.
Definition: PluginAdaptor.cpp:35
class Preferences * NewPreference(const std::string &name) const
Create a new preferences container.
Definition: PluginAdaptor.cpp:124
void RemoveReadDescriptor(ola::io::ReadFileDescriptor *descriptor)
Remove a ReadFileDescriptor for read-events.
Definition: PluginAdaptor.cpp:60