Global parameter handling for the Equalizer client library.
More...
#include <global.h>
|
static EQ_API void | setProgramName (const std::string &programName) |
| Set the name of the program. More...
|
|
static EQ_API const std::string & | getProgramName () |
|
static EQ_API void | setWorkDir (const std::string &workDir) |
| Set the working directory of the program. More...
|
|
static EQ_API const std::string & | getWorkDir () |
|
static NodeFactory * | getNodeFactory () |
|
static EQ_API void | setConfig (const std::string &config) |
| Set the config file or hwsd session for the app-local server. More...
|
|
static EQ_API const std::string & | getConfig () |
|
static void | enterCarbon () |
| Global lock for all non-thread-safe Carbon API calls. More...
|
|
static void | leaveCarbon () |
| Global unlock for non-thread-safe Carbon API calls. More...
|
|
static EQFABRIC_API void | setServer (const std::string &server) |
| Set the default Equalizer server. More...
|
|
static EQFABRIC_API const std::string & | getServer () |
|
static EQFABRIC_API ErrorRegistry & | getErrorRegistry () |
|
static EQFABRIC_API void | setFlags (const uint32_t flags) |
|
static EQFABRIC_API uint32_t | getFlags () |
|
static EQFABRIC_API void | setPrefixes (const Strings &prefixes) |
|
static EQFABRIC_API const Strings & | getPrefixes () |
|
|
EQ_API friend bool | _init (const int argc, char **argv, NodeFactory *) |
|
EQ_API friend bool | exit () |
| De-initialize the Equalizer fabric namespace. More...
|
|
Global parameter handling for the Equalizer client library.
Definition at line 33 of file global.h.
static void eq::Global::enterCarbon |
( |
| ) |
|
|
static |
Global lock for all non-thread-safe Carbon API calls.
Note: this is a NOP on non-AGL builds. Do not use unless you know the side effects, i.e., ask on the eq-dev mailing list.
- Version
- 1.0
static EQ_API const std::string& eq::Global::getConfig |
( |
| ) |
|
|
static |
- Returns
- the configuration for the app-local server.
- Version
- 1.0
- Returns
- the node factory.
- Version
- 1.0
Definition at line 49 of file global.h.
static EQ_API const std::string& eq::Global::getProgramName |
( |
| ) |
|
|
static |
- Returns
- the program name.
- Version
- 1.5.2
static EQ_API const std::string& eq::Global::getWorkDir |
( |
| ) |
|
|
static |
- Returns
- the working directory of the program.
- Version
- 1.5.2
static void eq::Global::leaveCarbon |
( |
| ) |
|
|
static |
Global unlock for non-thread-safe Carbon API calls.
- Version
- 1.0
static EQ_API void eq::Global::setConfig |
( |
const std::string & |
config | ) |
|
|
static |
Set the config file or hwsd session for the app-local server.
When started without specifying an explicit server connection, Equalizer will create an server instance in an application thread using this configuration. Strings ending with '.eqc' are considered Equalizer configuration files, otherwise the given string is used as an HWSD session name for auto-configuration.
- Parameters
-
config | the default configuration. |
- Version
- 1.0
static EQ_API void eq::Global::setProgramName |
( |
const std::string & |
programName | ) |
|
|
static |
Set the name of the program.
- Version
- 1.5.2
static EQ_API void eq::Global::setWorkDir |
( |
const std::string & |
workDir | ) |
|
|
static |
Set the working directory of the program.
- Version
- 1.5.2
EQ_API friend bool exit |
( |
| ) |
|
|
friend |
De-initialize the Equalizer fabric namespace.
- Returns
- true if the library was successfully de-initialized, false otherwise.
- Version
- 1.0
- Returns
- true if the library was successfully de-initialized, false otherwise.
The documentation for this class was generated from the following file: