eq::Global Class Reference

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

#include <global.h>

Collaboration diagram for eq::Global:

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	setConfigFile (const std::string &configFile)
	Set the config file for the app-local server.
static const std::string &	getConfigFile ()
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.
static const StringVector &	getPluginDirectories ()
static void	addPluginDirectory (const std::string &path)
	add a new directory to search for compressor DSOs.
static void	removePluginDirectory (const std::string &path)
	remove a plugin directory
static PluginRegistry &	getPluginRegistry ()
Friends
bool	init (const int argc, char *argv, NodeFactory nodeFactory)
	Initialize the Equalizer client library.
bool	exit ()
	De-initialize the Equalizer base classes.
bool	testInitPluginDirectories ()

Detailed Description

Global parameter handling for the Equalizer client library.

Definition at line 69 of file lib/client/global.h.

Member Function Documentation

static NodeFactory* eq::Global::getNodeFactory ( ) [inline, static]

Returns:: the node factory.

Definition at line 73 of file lib/client/global.h.

Referenced by eq::ConfigDeserializer::applyInstanceData(), eq::Layout::deserialize(), eq::Canvas::deserialize(), and eq::Pipe::getView().

Here is the caller graph for this function:

void eq::Global::setServer ( const std::string & server ) [static]

Set the default Equalizer server.

Parameters:

server

the default server.

Definition at line 53 of file lib/client/global.cpp.

const std::string & eq::Global::getServer ( ) [static]

Returns:: the default Equalizer server.

Definition at line 58 of file lib/client/global.cpp.

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

Here is the caller graph for this function:

void eq::Global::setConfigFile ( const std::string & configFile ) [static]

Set the config file for the app-local server.

Parameters:

configFile

the default configFile.

Definition at line 63 of file lib/client/global.cpp.

const std::string & eq::Global::getConfigFile ( ) [static]

Returns:: the default config file for the app-local server.

Definition at line 68 of file lib/client/global.cpp.

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 73 of file lib/client/global.cpp.

References eq::base::Lock::set().

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

Here is the call graph for this function:

Here is the caller graph for this function:

const StringVector & eq::Global::getPluginDirectories ( ) [static]

Returns:: all directories to search for compressor DSOs during eq::init().

Definition at line 88 of file lib/client/global.cpp.

void eq::Global::addPluginDirectory ( const std::string & path ) [static]

add a new directory to search for compressor DSOs.

Definition at line 93 of file lib/client/global.cpp.

PluginRegistry & eq::Global::getPluginRegistry ( ) [static]

Returns:: the plugin registry.

Definition at line 165 of file lib/client/global.cpp.

Referenced by eq::Image::allocCompressor(), and eq::Image::findCompressors().

Here is the caller graph for this function:

Friends And Related Function Documentation

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

Initialize the Equalizer client library.

The following command line options are recognized by this function:

--eq-server <hostname> to specify an explicit server address (cf. Global::setServer())
--eq-config <filename> to specify the configuration file if an application-specific server is used (cf. Global::setConfigFile())

Please note that further command line parameters are recognized by net::Node::initLocal().

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.

bool exit ( ) [friend]

De-initialize the Equalizer base classes.

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

Version:: 1.0

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

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

eq::Global Class Reference

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation