eq::Global Class Reference

#include <global.h>

Collaboration diagram for eq::Global:

[legend]

List of all members.

---

Detailed Description

Global parameter handling for the Equalizer client library.

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

Static Public Member Functions
static NodeFactory *	getNodeFactory ()
static void	setServer (const std::string &server)
	Set the default Equalizer server.
static const std::string &	getServer ()
static void	enterCarbon ()
	Global lock for all non-thread-safe Carbon API calls.
static void	leaveCarbon ()
	Global unlock for all non-thread-safe Carbon API calls.
Friends
EQ_EXPORT bool	init (const int argc, char **argv, NodeFactory *nodeFactory)
	Initialize the Equalizer client library.
EQ_EXPORT bool	exit ()
	De-initializes the Equalizer base classes.

---

Member Function Documentation

static NodeFactory* eq::Global::getNodeFactory

(

)

[inline, static]

Returns:

the node factory.

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

static void eq::Global::setServer

(

const std::string &

server

)

[inline, static]

Set the default Equalizer server.

Parameters:

server

the default server.

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

Referenced by eq::init().

Here is the caller graph for this function:

static const std::string& eq::Global::getServer

(

)

[inline, static]

Returns:

the default Equalizer server.

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

Referenced by eq::Client::connectServer().

Here is the caller graph for this function:

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.

Definition at line 19 of file client/global.cpp.

Referenced by eq::AGLWindow::chooseAGLPixelFormat(), eq::AGLWindow::configInitAGLFullscreen(), eq::AGLWindow::configInitAGLWindow(), eq::AGLWindow::createAGLContext(), eq::AGLEventHandler::deregisterWindow(), eq::AGLWindow::destroyAGLPixelFormat(), eq::AGLMessagePump::dispatchAll(), eq::AGLMessagePump::dispatchOne(), eq::AGLEventHandler::registerWindow(), and eq::AGLWindow::setCarbonWindow().

Here is the caller graph for this function:

---

Friends And Related Function Documentation

EQ_EXPORT bool init	(	const int	argc,
		char **	argv,
		NodeFactory *	nodeFactory
	)			[friend]

Initialize the Equalizer client library.

Parameters:

	argc	the command line argument count.
	argv	the command line argument values.
	nodeFactory	the factory for allocating Equalizer objects.

Returns:

true if the library was successfully initialised, false otherwise.

Definition at line 25 of file client/init.cpp.

EQ_EXPORT bool exit

(

)

[friend]

De-initializes the Equalizer base classes.

Returns:

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

Definition at line 21 of file base/init.cpp.

---

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

• client/global.h
• client/global.cpp