eq::Global Class Reference

Global parameter handling for the Equalizer client library. More...

#include <global.h>

Inheritance diagram for eq::Global:

Collaboration diagram for eq::Global:

Static Public Member Functions
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	setConfigFile (const std::string &configFile)
	Set the config file for the app-local server. More...
static EQ_API const std::string &	getConfigFile ()
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 Public Member Functions inherited from eq::fabric::Global
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 ()

Friends
EQ_API friend bool	_init (const int argc, char **argv, NodeFactory *nodeFactory)
EQ_API friend bool	exit ()
	De-initialize the Equalizer administrative library. More...

Detailed Description

Global parameter handling for the Equalizer client library.

Definition at line 33 of file client/global.h.

Member Function Documentation

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::getConfigFile ( )

static

Returns

the config file for the app-local server.

Version

1.0

static NodeFactory* eq::Global::getNodeFactory ( )

inlinestatic

Returns

the node factory.

Version

1.0

Definition at line 49 of file client/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::setConfigFile ( const std::string &  configFile )

static

Set the config file 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 config file.

Parameters

configFile

the default configFile.

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

Friends And Related Function Documentation

EQ_API friend bool exit ( )

friend

De-initialize the Equalizer administrative library.

This function also de-initializes the network layer, if the Equalizer client library is not initialized.

Returns

true if the library was successfully de-initialized, false otherwise.

true if the library was successfully de-initialized, false otherwise.

true if the library was successfully de-initialized, false otherwise.

Version

1.0

---

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

• client/global.h