Fawkes API  Fawkes Development Version
fawkes::PluginDirectorAspect Class Reference

Thread aspect to access the PluginManager. More...

#include <>>

Inheritance diagram for fawkes::PluginDirectorAspect:

Public Member Functions

 PluginDirectorAspect ()
 Constructor. More...
 
virtual ~PluginDirectorAspect ()
 Virtual empty Destructor. More...
 
void init_PluginDirectorAspect (PluginManager *manager)
 Set the PluginManager. More...
 
- Public Member Functions inherited from fawkes::Aspect
const std::list< const char * > & get_aspects () const
 Get list of aspect names attached to a aspected thread. More...
 

Protected Attributes

PluginManagerplugin_manager
 This is the member used to access the PluginManager. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Aspect
void add_aspect (const char *name)
 Add an aspect to a thread. More...
 

Detailed Description

Thread aspect to access the PluginManager.

Give this aspect to your thread to gain access to the plugin manager. The plugin manager can be used to load and unload plugins. Use this carefully, as it can interfere with the internals of the runtime system.

Note: This aspect can only be added for continuous threads, as plugins cannot be loaded while the main loop is running.

Author
Tim Niemueller

Definition at line 35 of file plugin_director.h.

Constructor & Destructor Documentation

◆ PluginDirectorAspect()

fawkes::PluginDirectorAspect::PluginDirectorAspect ( )

Constructor.

Definition at line 52 of file plugin_director.cpp.

References fawkes::Aspect::add_aspect().

◆ ~PluginDirectorAspect()

fawkes::PluginDirectorAspect::~PluginDirectorAspect ( )
virtual

Virtual empty Destructor.

Definition at line 58 of file plugin_director.cpp.

Member Function Documentation

◆ init_PluginDirectorAspect()

void fawkes::PluginDirectorAspect::init_PluginDirectorAspect ( PluginManager manager)

Set the PluginManager.

It is guaranteed that this is called for a configurable thread before Thread::start() is called (when running regularly inside Fawkes).

Parameters
managerPluginManager instance to use

Definition at line 69 of file plugin_director.cpp.

References plugin_manager.

Referenced by fawkes::PluginDirectorAspectIniFin::init().

Member Data Documentation

◆ plugin_manager

PluginManager * fawkes::PluginDirectorAspect::plugin_manager
protected

This is the member used to access the PluginManager.

The plugin manager will remain valid for the whole lifetime of the thread.

Definition at line 44 of file plugin_director.h.

Referenced by XmlRpcThread::init(), WebviewThread::init(), and init_PluginDirectorAspect().


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