Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::PluginAdaptor Class Reference
Inheritance diagram for ola::PluginAdaptor:
Inheritance graph
[legend]
Collaboration diagram for ola::PluginAdaptor:
Collaboration graph
[legend]

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. More...
 
bool AddReadDescriptor (ola::io::ReadFileDescriptor *descriptor)
 Register a ReadFileDescriptor for read-events. More...
 
bool AddReadDescriptor (ola::io::ConnectedDescriptor *descriptor, bool delete_on_close=false)
 Register a ConnectedDescriptor for read-events. More...
 
void RemoveReadDescriptor (ola::io::ReadFileDescriptor *descriptor)
 Remove a ReadFileDescriptor for read-events. More...
 
void RemoveReadDescriptor (ola::io::ConnectedDescriptor *descriptor)
 Remove a ConnectedDescriptor for read-events. More...
 
bool AddWriteDescriptor (ola::io::WriteFileDescriptor *descriptor)
 Register a WriteFileDescriptor for write-events. More...
 
void RemoveWriteDescriptor (ola::io::WriteFileDescriptor *descriptor)
 Remove a WriteFileDescriptor for write-events. More...
 
ola::thread::timeout_id RegisterRepeatingTimeout (unsigned int ms, Callback0< bool > *closure)
 Execute a callback periodically. More...
 
ola::thread::timeout_id RegisterRepeatingTimeout (const TimeInterval &interval, Callback0< bool > *closure)
 Execute a callback periodically. More...
 
ola::thread::timeout_id RegisterSingleTimeout (unsigned int ms, SingleUseCallback0< void > *closure)
 Execute a callback after a certain time interval. More...
 
ola::thread::timeout_id RegisterSingleTimeout (const TimeInterval &interval, SingleUseCallback0< void > *closure)
 Execute a callback after a certain time interval. More...
 
void RemoveTimeout (ola::thread::timeout_id id)
 Cancel an existing timeout. More...
 
void Execute (ola::BaseCallback0< void > *closure)
 Execute the supplied callback at some point in the future. More...
 
const TimeStampWakeUpTime () const
 The time when this SelectServer was woken up. More...
 
const std::string InstanceName () const
 Return the instance name for the OLA server. More...
 
ExportMapGetExportMap () const
 
bool RegisterDevice (class AbstractDevice *device) const
 Register a device. More...
 
bool UnregisterDevice (class AbstractDevice *device) const
 Unregister a device. More...
 
class PreferencesNewPreference (const std::string &name) const
 Create a new preferences container. More...
 
class PortBrokerInterfaceGetPortBroker () const
 
void DrainCallbacks ()
 Run all callbacks until there are none left.
 

Constructor & Destructor Documentation

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.

Parameters
device_managerpointer to a DeviceManager object
select_serverpointer to the SelectServer object
export_mappointer to the ExportMap object
preferences_factorypointer to the PreferencesFactory object
port_brokerpointer to the PortBroker object
instance_namethe instance name of this OlaServer

Member Function Documentation

bool ola::PluginAdaptor::AddReadDescriptor ( ola::io::ReadFileDescriptor descriptor)
virtual

Register a ReadFileDescriptor for read-events.

Parameters
descriptorthe ReadFileDescriptor to add.
Returns
true if the descriptor was added, false if the descriptor was previously added.

When the descriptor is ready for reading, PerformRead() will be called.

Implements ola::io::SelectServerInterface.

bool ola::PluginAdaptor::AddReadDescriptor ( ola::io::ConnectedDescriptor descriptor,
bool  delete_on_close = false 
)
virtual

Register a ConnectedDescriptor for read-events.

Parameters
descriptorthe ConnectedDescriptor to add.
delete_on_closeif true, ownership of the ConnectedDescriptor is transferred to the SelectServer.
Returns
true if the descriptor was added, false if the descriptor was previously added.

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.

bool ola::PluginAdaptor::AddWriteDescriptor ( ola::io::WriteFileDescriptor descriptor)
virtual

Register a WriteFileDescriptor for write-events.

Parameters
descriptorthe WriteFileDescriptor to add.

When the descriptor is writeable, PerformWrite() is called.

Implements ola::io::SelectServerInterface.

void ola::PluginAdaptor::Execute ( ola::BaseCallback0< void > *  callback)
virtual

Execute the supplied callback at some point in the future.

Parameters
callbackthe callback to run.

This method provides the following guarantees:

  • The callback will not be run immediately.
  • The callback will be run at some point in the future. That is, the callback will not leak. Any remaining pending callbacks will be run during the destruction of the class implementing ExecutorInterface.
  • For a given thread, callbacks will be run in the order in which they were added.

When queuing callbacks, you need to ensure that either:

  • The objects used in the callback outlive the ExecutorInterface
  • That the callback is run before the objects are deleted.

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 ( ) const

Return the instance name for the OLA server.

Returns
a string which is the instance name
Preferences * ola::PluginAdaptor::NewPreference ( const std::string &  name) const

Create a new preferences container.

Returns
a Preferences object
bool ola::PluginAdaptor::RegisterDevice ( class AbstractDevice device) const

Register a device.

Parameters
devicethe device to register
Returns
true on success, false on error
timeout_id ola::PluginAdaptor::RegisterRepeatingTimeout ( unsigned int  period,
Callback0< bool > *  callback 
)
virtual

Execute a callback periodically.

Parameters
periodthe number of milliseconds between each execution of the callback.
callbackthe callback to run. Ownership is transferred.
Returns
a timeout_id which can be used later to cancel the timeout.
Deprecated:
Use the version that takes a TimeInterval instead.

Returning false from the callback will cause it to be cancelled.

Implements ola::io::SelectServerInterface.

timeout_id ola::PluginAdaptor::RegisterRepeatingTimeout ( const TimeInterval period,
Callback0< bool > *  callback 
)
virtual

Execute a callback periodically.

Parameters
periodthe time interval between each execution of the callback.
callbackthe callback to run. Ownership is transferred.
Returns
a timeout_id which can be used later to cancel the timeout.

Returning false from the callback will cause it to be cancelled.

Implements ola::io::SelectServerInterface.

timeout_id ola::PluginAdaptor::RegisterSingleTimeout ( unsigned int  delay,
SingleUseCallback0< void > *  callback 
)
virtual

Execute a callback after a certain time interval.

Parameters
delaythe number of milliseconds before the callback is executed.
callbackthe callback to run. Ownership is transferred.
Returns
a timeout_id which can be used later to cancel the timeout.
Deprecated:
Use the version that takes a TimeInterval instead.

Implements ola::io::SelectServerInterface.

timeout_id ola::PluginAdaptor::RegisterSingleTimeout ( const TimeInterval delay,
SingleUseCallback0< void > *  callback 
)
virtual

Execute a callback after a certain time interval.

Parameters
delaythe time interval to wait before the callback is executed.
callbackthe callback to run. Ownership is transferred.
Returns
a timeout_id which can be used later to cancel the timeout.

Implements ola::io::SelectServerInterface.

void ola::PluginAdaptor::RemoveReadDescriptor ( ola::io::ReadFileDescriptor descriptor)
virtual

Remove a ReadFileDescriptor for read-events.

Parameters
descriptorthe descriptor to remove.
Warning
Descriptors must be removed from the SelectServer before they are closed. Not doing so will result in hard to debug failures.

Implements ola::io::SelectServerInterface.

void ola::PluginAdaptor::RemoveReadDescriptor ( ola::io::ConnectedDescriptor descriptor)
virtual

Remove a ConnectedDescriptor for read-events.

Parameters
descriptorthe descriptor to remove.
Warning
Descriptors must be removed from the SelectServer before they are closed. Not doing so will result in hard to debug failures.

Implements ola::io::SelectServerInterface.

void ola::PluginAdaptor::RemoveTimeout ( ola::thread::timeout_id  id)
virtual

Cancel an existing timeout.

Parameters
idthe timeout_id returned by a call to RegisterRepeatingTimeout or RegisterSingleTimeout.

Implements ola::io::SelectServerInterface.

void ola::PluginAdaptor::RemoveWriteDescriptor ( ola::io::WriteFileDescriptor descriptor)
virtual

Remove a WriteFileDescriptor for write-events.

Parameters
descriptorthe descriptor to remove.
Warning
Descriptors must be removed from the SelectServer before they are closed. Not doing so will result in hard to debug failures.

Implements ola::io::SelectServerInterface.

bool ola::PluginAdaptor::UnregisterDevice ( class AbstractDevice device) const

Unregister a device.

Parameters
devicethe device to unregister
Returns
true on success, false on error
const TimeStamp * ola::PluginAdaptor::WakeUpTime ( ) const
virtual

The time when this SelectServer was woken up.

Returns
The TimeStamp of when the 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.


The documentation for this class was generated from the following files: