BT::SharedLibrary Class Reference

#include <shared_library.h>

Public Types
enum	Flags { SHLIB_GLOBAL = 1 , SHLIB_LOCAL = 2 }

Public Member Functions
	SharedLibrary ()
	Creates a SharedLibrary object.
	SharedLibrary (const std::string &path, int flags=0)
virtual	~SharedLibrary ()=default
void	load (const std::string &path, int flags=0)
void	unload ()
	Unloads a shared library.
bool	isLoaded () const
	Returns true iff a library has been loaded.
bool	hasSymbol (const std::string &name)
void *	getSymbol (const std::string &name)
const std::string &	getPath () const
	SharedLibrary (const SharedLibrary &)=delete
SharedLibrary &	operator= (const SharedLibrary &)=delete
	SharedLibrary (SharedLibrary &&)=delete
SharedLibrary &	operator= (SharedLibrary &&)=delete

Static Public Member Functions
static std::string	prefix ()
static std::string	suffix ()
static std::string	getOSName (const std::string &name)

Detailed Description

The SharedLibrary class dynamically loads shared libraries at run-time.

Member Enumeration Documentation

Flags

enum BT::SharedLibrary::Flags

Enumerator
SHLIB_GLOBAL	On platforms that use dlopen(), use RTLD_GLOBAL. This is the default if no flags are given. This flag is ignored on platforms that do not use dlopen().
SHLIB_LOCAL	On platforms that use dlopen(), use RTLD_LOCAL instead of RTLD_GLOBAL. Note that if this flag is specified, RTTI (including dynamic_cast and throw) will not work for types defined in the shared library with GCC and possibly other compilers as well. See http://gcc.gnu.org/faq.html#dso for more information. This flag is ignored on platforms that do not use dlopen().

Constructor & Destructor Documentation

SharedLibrary()

BT::SharedLibrary::SharedLibrary	(	const std::string &	path,
		int	flags = 0
	)

Creates a SharedLibrary object and loads a library from the given path, using the given flags. See the Flags enumeration for valid values.

~SharedLibrary()

virtual BT::SharedLibrary::~SharedLibrary ( )

virtualdefault

Destroys the SharedLibrary. The actual library remains loaded.

Member Function Documentation

getOSName()

static std::string BT::SharedLibrary::getOSName ( const std::string &  name )

static

Returns the platform-specific filename for shared libraries by prefixing and suffixing name with prefix() and suffix()

getPath()

const std::string & BT::SharedLibrary::getPath

(

)

const

Returns the path of the library, as specified in a call to load() or the constructor.

getSymbol()

void * BT::SharedLibrary::getSymbol

(

const std::string &

name

)

Returns the address of the symbol with the given name. For functions, this is the entry point of the function. Throws a NotFoundException if the symbol does not exist.

hasSymbol()

bool BT::SharedLibrary::hasSymbol

(

const std::string &

name

)

Returns true iff the loaded library contains a symbol with the given name.

load()

void BT::SharedLibrary::load	(	const std::string &	path,
		int	flags = 0
	)

Loads a shared library from the given path, using the given flags. See the Flags enumeration for valid values. Throws a LibraryAlreadyLoadedException if a library has already been loaded. Throws a LibraryLoadException if the library cannot be loaded.

prefix()

static std::string BT::SharedLibrary::prefix ( )

static

Returns the platform-specific filename prefix for shared libraries. Most platforms would return "lib" as prefix, while on Cygwin, the "cyg" prefix will be returned.

suffix()

static std::string BT::SharedLibrary::suffix ( )

static

Returns the platform-specific filename suffix for shared libraries (including the period). In debug mode, the suffix also includes a "d" to specify the debug version of a library.

---

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

• include/behaviortree_cpp/utils/shared_library.h