RTC Toolkit 4.0.1
Loading...
Searching...
No Matches
Macros
config.hpp File Reference

Project-wide configuration header. More...

Go to the source code of this file.

Macros

#define RTCTK_API   __attribute__((visibility("default")))
 Helper to indicate that a class or function must be exported in the public symbol table.
 
#define RTCTK_LOCAL   __attribute__((visibility("hidden")))
 Helper to hide a class or function from the public symbol table.
 
#define RTCTK_NOEXCEPT   noexcept
 

Detailed Description

Project-wide configuration header.

Macro Definition Documentation

◆ RTCTK_API

#define RTCTK_API   __attribute__((visibility("default")))

Helper to indicate that a class or function must be exported in the public symbol table.

This macro can be used with shared libraries that have symbols hidden by default, but where certain functions or classes should be exported, so that one can link against them. The following examples show how to use this macro:

RTCTK_API int MyFunction();
class RTCTK_API MyClass {
...
};
#define RTCTK_API
Helper to indicate that a class or function must be exported in the public symbol table.
Definition: config.hpp:33
See also
https://gcc.gnu.org/wiki/Visibility

◆ RTCTK_LOCAL

#define RTCTK_LOCAL   __attribute__((visibility("hidden")))

Helper to hide a class or function from the public symbol table.

This macro can be used in shared libraries to make sure certain functions and classes are hidden from the export symbol table, i.e. to make sure these cannot be linked against. The following examples show how to use this macro:

RTCTK_LOCAL int MyFunction();
class MyInternalClass {
public:
...
private:
RTCTK_LOCAL int MyMethod();
};
class RTCTK_LOCAL MyInternalClass {
...
};
#define RTCTK_LOCAL
Helper to hide a class or function from the public symbol table.
Definition: config.hpp:60
See also
https://gcc.gnu.org/wiki/Visibility

◆ RTCTK_NOEXCEPT

#define RTCTK_NOEXCEPT   noexcept