apollo::cyber::class_loader::SharedLibrary类 参考

#include <shared_library.h>

apollo::cyber::class_loader::SharedLibrary 的协作图:

Public 类型
enum	Flags { SHLIB_GLOBAL = 1 , SHLIB_LOCAL = 2 }

Public 成员函数
	SharedLibrary ()=default
virtual	~SharedLibrary ()
	SharedLibrary (const std::string &path)
	SharedLibrary (const std::string &path, int flags)
void	Load (const std::string &path)
void	Load (const std::string &path, int flags)
void	Unload ()
bool	IsLoaded ()
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

详细描述

在文件 shared_library.h 第 40 行定义.

成员枚举类型说明

Flags

enum apollo::cyber::class_loader::SharedLibrary::Flags

枚举值
SHLIB_GLOBAL
SHLIB_LOCAL

在文件 shared_library.h 第 42 行定义.

             {
    // On platforms that use dlopen(), use RTLD_GLOBAL. This is the default
    // if no flags are given.
    SHLIB_GLOBAL = 1,
 
    // 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.
    SHLIB_LOCAL = 2,
  };

构造及析构函数说明

SharedLibrary() [1/4]

apollo::cyber::class_loader::SharedLibrary::SharedLibrary ( )

default

~SharedLibrary()

apollo::cyber::class_loader::SharedLibrary::~SharedLibrary ( )

virtual

在文件 shared_library.cc 第 90 行定义.

{}

SharedLibrary() [2/4]

apollo::cyber::class_loader::SharedLibrary::SharedLibrary ( const std::string &  path )

explicit

在文件 shared_library.cc 第 34 行定义.

{ Load(path, 0); }

SharedLibrary() [3/4]

apollo::cyber::class_loader::SharedLibrary::SharedLibrary	(	const std::string &	path,
		int	flags
	)

在文件 shared_library.cc 第 36 行定义.

                                                             {
  Load(path, flags);
}

SharedLibrary() [4/4]

apollo::cyber::class_loader::SharedLibrary::SharedLibrary ( const SharedLibrary &  )

delete

成员函数说明

GetPath()

const std::string & apollo::cyber::class_loader::SharedLibrary::GetPath ( ) const

inline

在文件 shared_library.h 第 108 行定义.

{ return path_; }

GetSymbol()

void * apollo::cyber::class_loader::SharedLibrary::GetSymbol

(

const std::string &

name

)

在文件 shared_library.cc 第 78 行定义.

                                                    {
  std::lock_guard<std::mutex> lock(mutex_);
  if (!handle_) return nullptr;
 
  void* result = dlsym(handle_, name.c_str());
  if (!result) {
    throw SymbolNotFoundException(name);
  }
 
  return result;
}

HasSymbol()

bool apollo::cyber::class_loader::SharedLibrary::HasSymbol

(

const std::string &

name

)

在文件 shared_library.cc 第 74 行定义.

                                                   {
  return GetSymbol(name) != nullptr;
}

IsLoaded()

bool apollo::cyber::class_loader::SharedLibrary::IsLoaded

(

)

在文件 shared_library.cc 第 69 行定义.

                             {
  std::lock_guard<std::mutex> lock(mutex_);
  return handle_ != nullptr;
}

Load() [1/2]

void apollo::cyber::class_loader::SharedLibrary::Load

(

const std::string &

path

)

在文件 shared_library.cc 第 40 行定义.

{ Load(path, 0); }

Load() [2/2]

void apollo::cyber::class_loader::SharedLibrary::Load	(	const std::string &	path,
		int	flags
	)

在文件 shared_library.cc 第 42 行定义.

                                                         {
  std::lock_guard<std::mutex> lock(mutex_);
  if (handle_) throw LibraryAlreadyLoadedException(path);
 
  int real_flag = RTLD_LAZY;
  if (flags & SHLIB_LOCAL) {
    real_flag |= RTLD_LOCAL;
  } else {
    real_flag |= RTLD_GLOBAL;
  }
  handle_ = dlopen(path.c_str(), real_flag);
  if (!handle_) {
    const char* err = dlerror();
    throw LibraryLoadException(err ? std::string(err) : path);
  }
 
  path_ = path;
}

operator=()

SharedLibrary & apollo::cyber::class_loader::SharedLibrary::operator= ( const SharedLibrary &  )

delete

Unload()

void apollo::cyber::class_loader::SharedLibrary::Unload

(

)

在文件 shared_library.cc 第 61 行定义.

                           {
  std::lock_guard<std::mutex> lock(mutex_);
  if (handle_) {
    dlclose(handle_);
    handle_ = nullptr;
  }
}

---

该类的文档由以下文件生成:

• cyber/class_loader/shared_library/shared_library.h
• cyber/class_loader/shared_library/shared_library.cc