YACS::BASES::DynLibLoaderGNU Class Reference

#include <DynLibLoaderGNU.hxx>

Collaboration diagram for YACS::BASES::DynLibLoaderGNU:

Public Member Functions
	DynLibLoaderGNU (const std::string &libNameWithoutExtension)
	~DynLibLoaderGNU ()
bool	isLibFileFindable () const
std::string	getLibNameWithoutExt () const
int	appendDirInSearchPath (const std::string &dirName)
int	removeDirInSearchPath (const std::string &dirName)
void *	getHandleOnSymbolWithName (const std::string &symbName, bool stopOnError=true)
bool	load ()
bool	reload ()
bool	unload ()

Static Public Member Functions
static const char *	getExtensionForDynLib ()

Private Member Functions
void	loadLib ()
void *	resolveSymb (const std::string &symbName, bool stopOnError)
	load lib without regarding that _libName is reachable More...
	DynLibLoaderGNU (const DynLibLoaderGNU &orig)
DynLibLoaderGNU &	operator= (const DynLibLoaderGNU &orig)

Private Attributes
void *	_handleOnLoadedLib
std::string	_libName

Static Private Attributes
static const char	_extForDynLib [] =".so"

Detailed Description

Definition at line 29 of file DynLibLoaderGNU.hxx.

Constructor & Destructor Documentation

DynLibLoaderGNU() [1/2]

DynLibLoaderGNU::DynLibLoaderGNU

(

const std::string &

libNameWithoutExtension

)

Definition at line 33 of file DynLibLoaderGNU.cxx.

                                                                        :_libName(libNameWithoutExtension),
                                                                             _handleOnLoadedLib(0)
{
}

~DynLibLoaderGNU()

DynLibLoaderGNU::~DynLibLoaderGNU

(

)

Definition at line 38 of file DynLibLoaderGNU.cxx.

{
  if(_handleOnLoadedLib)
    dlclose(_handleOnLoadedLib);
}

References _handleOnLoadedLib.

DynLibLoaderGNU() [2/2]

YACS::BASES::DynLibLoaderGNU::DynLibLoaderGNU ( const DynLibLoaderGNU &  orig )

inlineprivate

Definition at line 54 of file DynLibLoaderGNU.hxx.

{}

Member Function Documentation

appendDirInSearchPath()

int DynLibLoaderGNU::appendDirInSearchPath

(

const std::string &

dirName

)

Append a directory with name dirName to the searching paths.

Returns

If append succeeds 0 is returned. If the directory does not exists 1 is returned. If the addition of directory causes some troubles due to seach paths name 2 is returned.

Definition at line 60 of file DynLibLoaderGNU.cxx.

{
  return 0;
}

getExtensionForDynLib()

const char * DynLibLoaderGNU::getExtensionForDynLib ( )

static

Definition at line 137 of file DynLibLoaderGNU.cxx.

{
  return _extForDynLib+1;
}

References _extForDynLib.

getHandleOnSymbolWithName()

void * DynLibLoaderGNU::getHandleOnSymbolWithName	(	const std::string &	symbName,
		bool	stopOnError = true
	)

Definition at line 76 of file DynLibLoaderGNU.cxx.

{
  if(!_handleOnLoadedLib)
    if(!isLibFileFindable())
      {
        std::cerr << "Dynamic library with name " << symbName << _extForDynLib;
        std::cerr << " not existing in paths specified" << std::endl;
        return 0;
      }
    else
      loadLib();
  return resolveSymb(symbName, stopOnError);
}

References _extForDynLib, _handleOnLoadedLib, isLibFileFindable(), loadLib(), and resolveSymb().

getLibNameWithoutExt()

std::string DynLibLoaderGNU::getLibNameWithoutExt

(

)

const

Definition at line 49 of file DynLibLoaderGNU.cxx.

{
  return _libName;
}

References _libName.

isLibFileFindable()

bool DynLibLoaderGNU::isLibFileFindable

(

)

const

Definition at line 44 of file DynLibLoaderGNU.cxx.

{
  return true;
}

Referenced by getHandleOnSymbolWithName().

load()

bool DynLibLoaderGNU::load

(

)

Definition at line 90 of file DynLibLoaderGNU.cxx.

{
  std::string fullLibName(_libName);
  fullLibName+=_extForDynLib;
  dlerror();
  _handleOnLoadedLib=dlopen(fullLibName.c_str(),RTLD_LAZY | RTLD_GLOBAL);
  char *message=dlerror();
  if (message != NULL)
    {
      std::string error = "Error while trying to load library with name " + fullLibName +
                          " with the following internal message: " + message;
      throw YACS::Exception(error);
    }
  return _handleOnLoadedLib != NULL;
}

References _extForDynLib, _handleOnLoadedLib, and _libName.

Referenced by loadLib(), and reload().

loadLib()

void YACS::BASES::DynLibLoaderGNU::loadLib ( )

inlineprivate

Definition at line 49 of file DynLibLoaderGNU.hxx.

{ load(); }

References load().

Referenced by getHandleOnSymbolWithName().

operator=()

DynLibLoaderGNU & YACS::BASES::DynLibLoaderGNU::operator= ( const DynLibLoaderGNU &  orig )

inlineprivate

Definition at line 55 of file DynLibLoaderGNU.hxx.

{ return *this; }

reload()

bool DynLibLoaderGNU::reload

(

)

Definition at line 116 of file DynLibLoaderGNU.cxx.

{
  unload();
  return load();
}

References load(), and unload().

removeDirInSearchPath()

int DynLibLoaderGNU::removeDirInSearchPath

(

const std::string &

dirName

)

Removes a directory with name dirName from the searching paths.

Returns

If removal succeeds 0 is returned. If the directory does not exists 1 is returned. If the path were not already in existing paths 2 is returned.

Definition at line 71 of file DynLibLoaderGNU.cxx.

{
  return 0;
}

resolveSymb()

void * DynLibLoaderGNU::resolveSymb ( const std::string &  symbName, bool  stopOnError  )

private

load lib without regarding that _libName is reachable

Definition at line 122 of file DynLibLoaderGNU.cxx.

{
  dlerror();
  void *ret=dlsym(_handleOnLoadedLib,symbName.c_str());
  char *message=dlerror();
  if(stopOnError && (NULL != message))
    {
      std::string error="Error detected on symbol ";
      error=error+symbName +" search in library with name "+_libName+_extForDynLib+" with the following internal message "+message;
      throw YACS::Exception(error);
    }
  else
    return ret;
}

References _extForDynLib, _handleOnLoadedLib, and _libName.

Referenced by getHandleOnSymbolWithName().

unload()

bool DynLibLoaderGNU::unload

(

)

Definition at line 106 of file DynLibLoaderGNU.cxx.

{
  if (_handleOnLoadedLib) 
    {
      dlclose(_handleOnLoadedLib);
      _handleOnLoadedLib = NULL;
    }
  return false;
}

References _handleOnLoadedLib.

Referenced by reload().

Member Data Documentation

_extForDynLib

const char DynLibLoaderGNU::_extForDynLib =".so"

staticprivate

Definition at line 34 of file DynLibLoaderGNU.hxx.

Referenced by getExtensionForDynLib(), getHandleOnSymbolWithName(), load(), and resolveSymb().

_handleOnLoadedLib

void* YACS::BASES::DynLibLoaderGNU::_handleOnLoadedLib

private

Definition at line 32 of file DynLibLoaderGNU.hxx.

Referenced by getHandleOnSymbolWithName(), load(), resolveSymb(), unload(), and ~DynLibLoaderGNU().

_libName

std::string YACS::BASES::DynLibLoaderGNU::_libName

private

Definition at line 33 of file DynLibLoaderGNU.hxx.

Referenced by getLibNameWithoutExt(), load(), and resolveSymb().

---

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

• src/bases/DynLibLoaderGNU.hxx
• src/bases/DynLibLoaderGNU.cxx