fawkes::Module Class Reference

Interface representing a dynamically loaded software module. More...

#include <utils/system/dynamic_module/module.h>

Inheritance diagram for fawkes::Module:

Public Types

enum ModuleFlags {
MODULE_FLAGS_NONE = 0, MODULE_FLAGS_DEFAULT = 0x000E, MODULE_BIND_LAZY = 0x0001, MODULE_BIND_NOW = 0x0002,
MODULE_BIND_LOCAL = 0x0000, MODULE_BIND_GLOBAL = 0x0004, MODULE_BIND_MASK = 0x0003, MODULE_BIND_DEEP = 0x0008
}

Flags for the loading process. More...

Public Member Functions

virtual ~Module ()

Virtual empty destructor.

virtual void open ()=0

Open the module

Exceptions:

ModuleOpenException

thrown if there was any problem loading the module.

virtual bool close ()=0

Close the module.

virtual void ref ()=0

Increment the reference count of this module.

virtual void unref ()=0

Decrease the reference count of this module.

virtual bool notref ()=0

Check if there are no reference to this module.

virtual unsigned int get_ref_count ()=0

Get the reference count of this module.

virtual bool has_symbol (const char *symbol_name)=0

Check if the module has the given symbol.

virtual void * get_symbol (const char *symbol_name)=0

Get a symbol from the module.

virtual std::string get_filename ()=0

Get the full file name of the module.

virtual std::string get_base_filename ()=0

Get the base file name of the module.

Detailed Description

Interface representing a dynamically loaded software module.

Author:: Tim Niemueller

Definition at line 39 of file module.h.

Member Enumeration Documentation

enum fawkes::Module::ModuleFlags

Flags for the loading process.

Enumerator:

MODULE_FLAGS_NONE	No flags.
MODULE_FLAGS_DEFAULT	Default flags, these are MODULE_BIND_GLOBAL, MODULE_BIND_NOW and MODULE_BIND_DEEP.
MODULE_BIND_LAZY	Perform lazy binding. Only resolve symbols as thecode that references them is executed. If the symbol is never referenced,then it is never resolved. (Lazy binding is only performed for function references; references to variables are always immediately bound when the library is loaded.)
MODULE_BIND_NOW	Resolve all symbols immediately when loading the library. It's the opposite of MODULE_BIND_LAZY. It shall be the the default (makes sense for the framework robotics).
MODULE_BIND_LOCAL	Symbols defined in this library are not made available to resolve references in subsequently loaded libraries. It's the opposite of MODULE_BIND_GLOBAL. It shall be the default and MODULE_BIND_GLOBAL shall automatically override it.
MODULE_BIND_GLOBAL	Symbols defined in this library are not made available to resolve references in subsequently loaded libraries.
MODULE_BIND_MASK	Can be used to encode flags in a longer data field.
MODULE_BIND_DEEP	Place the lookup scope of the symbols in this library ahead of the global scope. This means that a self-contained library will use its own symbols in preference to global symbols with the same name contained in libraries that have already been loaded.