![]() |
Open Lighting Architecture 0.10.9
|
Public Member Functions | |
| 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. | |
| bool | AddReadDescriptor (ola::io::ReadFileDescriptor *descriptor) |
| Register a ReadFileDescriptor for read-events. | |
| bool | AddReadDescriptor (ola::io::ConnectedDescriptor *descriptor, bool delete_on_close=false) |
| Register a ConnectedDescriptor for read-events. | |
| void | RemoveReadDescriptor (ola::io::ReadFileDescriptor *descriptor) |
| Remove a ReadFileDescriptor for read-events. | |
| void | RemoveReadDescriptor (ola::io::ConnectedDescriptor *descriptor) |
| Remove a ConnectedDescriptor for read-events. | |
| bool | AddWriteDescriptor (ola::io::WriteFileDescriptor *descriptor) |
| Register a WriteFileDescriptor for write-events. | |
| void | RemoveWriteDescriptor (ola::io::WriteFileDescriptor *descriptor) |
| Remove a WriteFileDescriptor for write-events. | |
| ola::thread::timeout_id | RegisterRepeatingTimeout (unsigned int ms, Callback0< bool > *closure) |
| Execute a callback periodically. | |
| ola::thread::timeout_id | RegisterRepeatingTimeout (const TimeInterval &interval, Callback0< bool > *closure) |
| Execute a callback periodically. | |
| ola::thread::timeout_id | RegisterSingleTimeout (unsigned int ms, SingleUseCallback0< void > *closure) |
| Execute a callback after a certain time interval. | |
| ola::thread::timeout_id | RegisterSingleTimeout (const TimeInterval &interval, SingleUseCallback0< void > *closure) |
| Execute a callback after a certain time interval. | |
| void | RemoveTimeout (ola::thread::timeout_id id) |
| Cancel an existing timeout. | |
| void | Execute (ola::BaseCallback0< void > *closure) |
| Execute the supplied callback at some point in the future. | |
| const TimeStamp * | WakeUpTime () const |
| The time when this SelectServer was woken up. | |
| const std::string | InstanceName () |
| Return the instance name for the OLA server. | |
| ExportMap * | GetExportMap () const |
| bool | RegisterDevice (class AbstractDevice *device) const |
| Register a device. | |
| bool | UnregisterDevice (class AbstractDevice *device) const |
| Unregister a device. | |
| class Preferences * | NewPreference (const std::string &name) const |
| Create a new preferences container. | |
| class PortBrokerInterface * | GetPortBroker () const |
| void | DrainCallbacks () |
| Run all callbacks until there are none left. | |
| ola::PluginAdaptor::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.
| device_manager | pointer to a DeviceManager object |
| select_server | pointer to the SelectServer object |
| export_map | pointer to the ExportMap object |
| preferences_factory | pointer to the PreferencesFactory object |
| port_broker | pointer to the PortBroker object |
| instance_name | the instance name of this OlaServer |
|
virtual |
Register a ConnectedDescriptor for read-events.
| descriptor | the ConnectedDescriptor to add. |
| delete_on_close | if true, ownership of the ConnectedDescriptor is transferred to the SelectServer. |
When the descriptor is ready for reading, PerformRead() will be called. Prior to PerformRead(), IsClosed() is called. If this returns true, and delete_on_close was set, the descriptor will be deleted.
Implements ola::io::SelectServerInterface.
|
virtual |
Register a ReadFileDescriptor for read-events.
| descriptor | the ReadFileDescriptor to add. |
When the descriptor is ready for reading, PerformRead() will be called.
Implements ola::io::SelectServerInterface.
|
virtual |
Register a WriteFileDescriptor for write-events.
| descriptor | the WriteFileDescriptor to add. |
When the descriptor is writeable, PerformWrite() is called.
Implements ola::io::SelectServerInterface.
|
virtual |
Run all callbacks until there are none left.
Implements ola::thread::ExecutorInterface.
|
virtual |
Execute the supplied callback at some point in the future.
| callback | the callback to run. |
This method provides the following guarantees:
When queuing callbacks, you need to ensure that either:
To achieve the latter it's common to keep track of the number of outstanding callbacks and then call DrainCallbacks() in the destructor if the number of outstanding callbacks is non-0.
Implements ola::thread::ExecutorInterface.
| const std::string ola::PluginAdaptor::InstanceName | ( | ) |
Return the instance name for the OLA server.
| Preferences * ola::PluginAdaptor::NewPreference | ( | const std::string & | name | ) | const |
Create a new preferences container.
| bool ola::PluginAdaptor::RegisterDevice | ( | class AbstractDevice * | device | ) | const |
Register a device.
| device | the device to register |
|
virtual |
Execute a callback periodically.
| period | the time interval between each execution of the callback. |
| callback | the callback to run. Ownership is transferred. |
Returning false from the callback will cause it to be cancelled.
Implements ola::io::SelectServerInterface.
|
virtual |
Execute a callback periodically.
| period | the number of milliseconds between each execution of the callback. |
| callback | the callback to run. Ownership is transferred. |
Returning false from the callback will cause it to be cancelled.
Implements ola::io::SelectServerInterface.
|
virtual |
Execute a callback after a certain time interval.
| delay | the time interval to wait before the callback is executed. |
| callback | the callback to run. Ownership is transferred. |
Implements ola::io::SelectServerInterface.
|
virtual |
Execute a callback after a certain time interval.
| delay | the number of milliseconds before the callback is executed. |
| callback | the callback to run. Ownership is transferred. |
Implements ola::io::SelectServerInterface.
|
virtual |
Remove a ConnectedDescriptor for read-events.
| descriptor | the descriptor to remove. |
Implements ola::io::SelectServerInterface.
|
virtual |
Remove a ReadFileDescriptor for read-events.
| descriptor | the descriptor to remove. |
Implements ola::io::SelectServerInterface.
|
virtual |
Cancel an existing timeout.
| id | the timeout_id returned by a call to RegisterRepeatingTimeout or RegisterSingleTimeout. |
Implements ola::io::SelectServerInterface.
|
virtual |
Remove a WriteFileDescriptor for write-events.
| descriptor | the descriptor to remove. |
Implements ola::io::SelectServerInterface.
| bool ola::PluginAdaptor::UnregisterDevice | ( | class AbstractDevice * | device | ) | const |
Unregister a device.
| device | the device to unregister |
|
virtual |
The time when this SelectServer was woken up.
If running within the same thread as the SelectServer, this is a efficient way to get the current time.
Implements ola::io::SelectServerInterface.