eq Namespace Reference

---

Detailed Description

The Equalizer client library.

This namespace implements the application-visible API to access the Equalizer server.

Classes
class	AGLEventHandler
	The per-node event processing handler for agl windows. More...
class	AGLMessagePump
	Processes OS messages on AGL/Carbon. More...
class	AGLWindowIF
	The interface defining the minimum functionality for an AGL window. More...
class	AGLWindow
	Equalizer default implementation of an AGL window. More...
class	AGLWindowEvent
	A window-system event for an AGLWindowIF. More...
class	Channel
	A channel represents a two-dimensional viewport within a Window. More...
class	ChannelStatistics
	Holds one statistics event, used for profiling. More...
class	ChannelVisitor
	A visitor to traverse a non-const channels. More...
class	Client
	The client represents a network node in the cluster. More...
class	ColorMask
	Defines which parts of the color buffer are to be written. More...
class	CommandQueue
	Augments an net::CommandQueue to pump system-specific events where required by the underlying window/operating system. More...
class	Compositor
	A facility class for image assembly operations. More...
class	Config
	The configuration groups all processes of the application in a single net::Session. More...
struct	ConfigEvent
	A config event. More...
class	ConfigParams
class	ConfigStatistics
	Holds one statistics event, used for profiling. More...
class	ConfigVisitor
	A visitor to traverse a non-const configs and children. More...
struct	ResizeEvent
struct	PointerEvent
struct	KeyEvent
struct	Statistic
struct	UserEvent
struct	Event
class	EventHandler
	Base class for window system-specific event handlers. More...
class	Frame
	A holder for a frame data and parameters. More...
class	FrameData
	A frame data holds multiple images and is used by frames. More...
class	Global
	Global parameter handling for the Equalizer client library. More...
class	GLXEventHandler
	The event handler for glX. More...
class	GLXMessagePump
	Implements a message pump for the X11 window system. More...
class	GLXWindowIF
	The interface defining the minimum functionality for a GLX window. More...
class	GLXWindow
	Equalizer default implementation of a GLX window. More...
class	GLXWindowEvent
	A window-system event for a GLXWindowIF. More...
struct	RGBHeader
class	Image
	A holder for pixel data. More...
class	Matrix4
class	MessagePump
	Defines an interface to process OS messages/events. More...
class	Node
	A Node represents a single computer in the cluster. More...
class	NodeFactory
	The node factory is a per-node singleton used to create Equalizer resource instances. More...
class	NodeStatistics
	Holds one statistics event, used for profiling. More...
class	NodeVisitor
	A visitor to traverse a non-const nodes and children. More...
class	ObjectManager
	A facility class to managed OpenGL objects across shared contexts. More...
class	OSWindow
	The interface definition for OS-specific windowing code. More...
struct	ClientPacket
struct	ClientExitPacket
struct	ServerPacket
struct	ServerChooseConfigPacket
struct	ServerUseConfigPacket
struct	ServerCreateConfigPacket
struct	ServerDestroyConfigPacket
struct	ServerChooseConfigReplyPacket
struct	ServerReleaseConfigPacket
struct	ServerReleaseConfigReplyPacket
struct	ServerShutdownPacket
struct	ServerShutdownReplyPacket
struct	ConfigCreateReplyPacket
struct	ConfigCreateNodePacket
struct	ConfigCreateNodeReplyPacket
struct	ConfigDestroyNodePacket
struct	ConfigStartInitPacket
struct	ConfigStartInitReplyPacket
struct	ConfigFinishInitPacket
struct	ConfigFinishInitReplyPacket
struct	ConfigExitPacket
struct	ConfigExitReplyPacket
struct	ConfigStartFramePacket
struct	ConfigStartFrameReplyPacket
struct	ConfigFrameFinishPacket
struct	ConfigFinishAllFramesPacket
struct	ConfigFreezeLoadBalancingPacket
struct	ConfigStartClockPacket
struct	ConfigMapViewsPacket
struct	NodeConfigInitPacket
struct	NodeConfigInitReplyPacket
struct	NodeConfigExitPacket
struct	NodeConfigExitReplyPacket
struct	NodeCreatePipePacket
struct	NodeDestroyPipePacket
struct	NodeFrameStartPacket
struct	NodeFrameFinishPacket
struct	NodeFrameFinishReplyPacket
struct	NodeFrameDrawFinishPacket
struct	NodeFrameTasksFinishPacket
struct	PipeCreateWindowPacket
struct	PipeDestroyWindowPacket
struct	PipeConfigInitPacket
struct	PipeConfigInitReplyPacket
struct	PipeConfigExitPacket
struct	PipeConfigExitReplyPacket
struct	PipeFrameStartClockPacket
struct	PipeFrameStartPacket
struct	PipeFrameFinishPacket
struct	PipeFrameNoDrawPacket
struct	PipeFrameDrawFinishPacket
struct	PipeStopThreadPacket
struct	WindowConfigInitPacket
struct	WindowConfigInitReplyPacket
struct	WindowConfigExitPacket
struct	WindowConfigExitReplyPacket
struct	WindowCreateChannelPacket
struct	WindowDestroyChannelPacket
struct	WindowSetPVPPacket
struct	WindowFinishPacket
struct	WindowBarrierPacket
struct	WindowSwapPacket
struct	WindowFrameStartPacket
struct	WindowFrameFinishPacket
struct	WindowFrameDrawFinishPacket
struct	ChannelConfigInitPacket
struct	ChannelConfigInitReplyPacket
struct	ChannelConfigExitPacket
struct	ChannelConfigExitReplyPacket
struct	ChannelSetNearFarPacket
struct	ChannelFrameStartPacket
struct	ChannelFrameFinishPacket
struct	ChannelFrameFinishReplyPacket
struct	ChannelFrameDrawFinishPacket
struct	ChannelTaskPacket
struct	ChannelFrameClearPacket
struct	ChannelFrameDrawPacket
struct	ChannelFrameAssemblePacket
struct	ChannelFrameReadbackPacket
struct	ChannelFrameTransmitPacket
struct	FrameDataTransmitPacket
struct	FrameDataReadyPacket
struct	FrameDataUpdatePacket
struct	GLXEventThreadRegisterPipePacket
struct	GLXEventThreadDeregisterPipePacket
struct	GLXEventThreadRegisterWindowPacket
struct	GLXEventThreadDeregisterWindowPacket
class	Pipe
	A Pipe represents a graphics card (GPU) on a Node. More...
class	PipeVisitor
	A visitor to traverse a non-const pipes and children. More...
class	Pixel
	Holds a pixel decomposition specification along with some methods for manipulation. More...
class	PixelViewport
	Holds a pixel viewport along with some methods for manipulation. More...
class	Projection
	A projection definition defining a view frustum. More...
class	Range
	Holds a fractional range along with some methods for manipulation. More...
struct	RenderContext
	The context applied by the server during rendering operations. More...
class	Server
class	Version
class	View
	A View describes the projection of the scene onto a coherent 2D area, typically a display driven by a destination Channel. More...
class	Viewport
	Holds a fractional viewport along with some methods for manipulation. More...
class	Wall
	A wall defining a view frustum. More...
class	WGLEventHandler
	The event processing for WGL. More...
class	WGLMessagePump
	Processes OS messages on Win32 systems. More...
class	WGLWindowIF
	The interface defining the minimum functionality for a WGL window. More...
class	WGLWindow
	Equalizer default implementation of a WGL window. More...
class	WGLWindowEvent
	A window-system event for a WGLWindowIF. More...
class	Window
	A Window represents an on-screen or off-screen drawable, and manages an OpenGL context. More...
class	WindowStatistics
	Holds one statistics event, used for profiling. More...
class	WindowVisitor
	A visitor to traverse a non-const windows and children. More...
class	X11Connection
Namespaces
namespace	base
	Equalizer base OS abstraction layer.
namespace	net
	The Equalizer networking abstraction layer.
namespace	util
	Equalizer utility classes.
Typedefs
typedef net::CommandFunc< Channel >	ChannelFunc
typedef net::CommandFunc< Client >	ClientFunc
typedef net::ConnectionPtr(*	eqsStartLocalServer_t )()
typedef void(*	eqsJoinLocalServer_t )()
typedef net::CommandFunc< Config >	ConfigFunc
typedef base::RefPtr < GLXEventHandler::EventSet >	GLXEventSetPtr
typedef Matrix4< float >	Matrix4f
typedef Matrix4< double >	Matrix4d
typedef net::CommandFunc< Node >	NodeFunc
typedef stde::hash_map < uint32_t, FrameData * >	FrameDataCache
typedef net::SessionPacket	ConfigPacket
typedef net::CommandFunc< Pipe >	PipeFunc
typedef std::vector< Node * >	NodeVector
typedef std::vector< Pipe * >	PipeVector
typedef std::vector< Window * >	WindowVector
typedef std::vector< Channel * >	ChannelVector
typedef std::vector< Frame * >	FrameVector
typedef std::vector< Image * >	ImageVector
typedef std::vector< View * >	ViewVector
typedef base::RefPtr < X11Connection >	X11ConnectionPtr
typedef base::RefPtr< Client >	ClientPtr
typedef base::RefPtr< Server >	ServerPtr
typedef std::vector< Statistic >	Statistics
typedef std::map< uint32_t, Statistics >	SortedStatistics
typedef std::pair< uint32_t, SortedStatistics >	FrameStatistics
Enumerations
enum	ServerCommand {   CMD_SERVER_CHOOSE_CONFIG = net::CMD_NODE_CUSTOM, CMD_SERVER_USE_CONFIG, CMD_SERVER_CHOOSE_CONFIG_REPLY, CMD_SERVER_CREATE_CONFIG,   CMD_SERVER_CREATE_CONFIG_REPLY, CMD_SERVER_DESTROY_CONFIG, CMD_SERVER_RELEASE_CONFIG, CMD_SERVER_RELEASE_CONFIG_REPLY,   CMD_SERVER_INIT_CONFIG, CMD_SERVER_SHUTDOWN, CMD_SERVER_SHUTDOWN_REPLY, CMD_SERVER_CUSTOM }
enum	ClientCommand { CMD_CLIENT_EXIT = net::CMD_NODE_CUSTOM, CMD_CLIENT_CUSTOM }
enum	ConfigCommand {   CMD_CONFIG_START_INIT = net::CMD_SESSION_CUSTOM, CMD_CONFIG_START_INIT_REPLY, CMD_CONFIG_FINISH_INIT, CMD_CONFIG_FINISH_INIT_REPLY,   CMD_CONFIG_EXIT, CMD_CONFIG_EXIT_REPLY, CMD_CONFIG_CREATE_REPLY, CMD_CONFIG_CREATE_NODE,   CMD_CONFIG_CREATE_NODE_REPLY, CMD_CONFIG_DESTROY_NODE, CMD_CONFIG_START_FRAME, CMD_CONFIG_START_FRAME_REPLY,   CMD_CONFIG_FRAME_FINISH, CMD_CONFIG_FINISH_ALL_FRAMES, CMD_CONFIG_EVENT, CMD_CONFIG_DATA,   CMD_CONFIG_FREEZE_LOAD_BALANCING, CMD_CONFIG_START_CLOCK, CMD_CONFIG_MAP_VIEWS, CMD_CONFIG_CUSTOM }
enum	NodeCommand {   CMD_NODE_CONFIG_INIT = net::CMD_OBJECT_CUSTOM, CMD_NODE_CONFIG_INIT_REPLY, CMD_NODE_CONFIG_EXIT, CMD_NODE_CONFIG_EXIT_REPLY,   CMD_NODE_CREATE_PIPE, CMD_NODE_DESTROY_PIPE, CMD_NODE_FRAME_START, CMD_NODE_FRAME_FINISH,   CMD_NODE_FRAME_FINISH_REPLY, CMD_NODE_FRAME_DRAW_FINISH, CMD_NODE_FRAME_TASKS_FINISH, CMD_NODE_CUSTOM }
enum	PipeCommand {   CMD_PIPE_CONFIG_INIT = net::CMD_OBJECT_CUSTOM, CMD_PIPE_CONFIG_INIT_REPLY, CMD_PIPE_CONFIG_EXIT, CMD_PIPE_CONFIG_EXIT_REPLY,   CMD_PIPE_CREATE_WINDOW, CMD_PIPE_DESTROY_WINDOW, CMD_PIPE_FRAME_START, CMD_PIPE_FRAME_FINISH,   CMD_PIPE_FRAME_DRAW_FINISH, CMD_PIPE_FRAME_NO_DRAW, CMD_PIPE_STOP_THREAD, CMD_PIPE_FRAME_START_CLOCK,   CMD_PIPE_CUSTOM }
enum	WindowCommand {   CMD_WINDOW_CONFIG_INIT = net::CMD_OBJECT_CUSTOM, CMD_WINDOW_CONFIG_INIT_REPLY, CMD_WINDOW_CONFIG_EXIT, CMD_WINDOW_CONFIG_EXIT_REPLY,   CMD_WINDOW_CREATE_CHANNEL, CMD_WINDOW_DESTROY_CHANNEL, CMD_WINDOW_SET_PVP, CMD_WINDOW_FRAME_START,   CMD_WINDOW_FRAME_FINISH, CMD_WINDOW_FINISH, CMD_WINDOW_BARRIER, CMD_WINDOW_SWAP,   CMD_WINDOW_FRAME_DRAW_FINISH, CMD_WINDOW_CUSTOM }
enum	ChannelCommand {   CMD_CHANNEL_CONFIG_INIT = net::CMD_OBJECT_CUSTOM, CMD_CHANNEL_CONFIG_INIT_REPLY, CMD_CHANNEL_CONFIG_EXIT, CMD_CHANNEL_CONFIG_EXIT_REPLY,   CMD_CHANNEL_SET_NEARFAR, CMD_CHANNEL_FRAME_START, CMD_CHANNEL_FRAME_FINISH, CMD_CHANNEL_FRAME_FINISH_REPLY,   CMD_CHANNEL_FRAME_CLEAR, CMD_CHANNEL_FRAME_DRAW, CMD_CHANNEL_FRAME_DRAW_FINISH, CMD_CHANNEL_FRAME_ASSEMBLE,   CMD_CHANNEL_FRAME_READBACK, CMD_CHANNEL_FRAME_TRANSMIT, CMD_CHANNEL_CUSTOM }
enum	FrameDataCommand { CMD_FRAMEDATA_TRANSMIT = net::CMD_OBJECT_CUSTOM, CMD_FRAMEDATA_READY, CMD_FRAMEDATA_UPDATE, CMD_FRAMEDATA_CUSTOM }
enum	GLXEventThreadCommand {   CMD_GLXEVENTTHREAD_REGISTER_PIPE, CMD_GLXEVENTTHREAD_DEREGISTER_PIPE, CMD_GLXEVENTTHREAD_REGISTER_WINDOW, CMD_GLXEVENTTHREAD_DEREGISTER_WINDOW,   CMD_GLXEVENTTHREAD_ALL }
enum	KeyCode {   KC_ESCAPE = 256, KC_BACKSPACE, KC_RETURN, KC_TAB,   KC_HOME, KC_LEFT, KC_UP, KC_RIGHT,   KC_DOWN, KC_PAGE_UP, KC_PAGE_DOWN, KC_END,   KC_F1, KC_F2, KC_F3, KC_F4,   KC_F5, KC_F6, KC_F7, KC_F8,   KC_F9, KC_F10, KC_F11, KC_F12,   KC_F13, KC_F14, KC_F15, KC_F16,   KC_F17, KC_F18, KC_F19, KC_F20,   KC_F21, KC_F22, KC_F23, KC_F24,   KC_SHIFT_L, KC_SHIFT_R, KC_CONTROL_L, KC_CONTROL_R,   KC_ALT_L, KC_ALT_R, KC_VOID = 0xFFFFFF }
	Yet another key code table to report keys in a window system independent way. More...
enum	PointerButton {   PTR_BUTTON_NONE = EQ_BIT_NONE, PTR_BUTTON1 = EQ_BIT1, PTR_BUTTON2 = EQ_BIT2, PTR_BUTTON3 = EQ_BIT3,   PTR_BUTTON4 = EQ_BIT4, PTR_BUTTON5 = EQ_BIT5 }
	Mouse pointer button definition. More...
enum	Eye { EYE_CYCLOP = 0, EYE_LEFT, EYE_RIGHT, EYE_ALL }
	Defines an eye pass.
enum	IAttrValue {   UNDEFINED = -0xfffffff, LOCAL_SYNC = -10, DRAW_SYNC = -9, ASYNC = -8,   PBUFFER = -7, WINDOW = -6, VERTICAL = -5, QUAD = -4,   ANAGLYPH = -3, NICEST = -2, AUTO = -1, OFF = 0,   ON = 1, FASTEST = ON, HORIZONTAL = ON }
	Possible values for some integer attributes.
enum	LogTopics {   LOG_ASSEMBLY = net::LOG_CUSTOM, LOG_TASKS = 0x200, LOG_EVENTS = 0x400, LOG_STATS = 0x800,   LOG_SERVER = 0x1000, LOG_CUSTOM = 0x10000 }
enum	NodeType { TYPE_EQ_SERVER = net::TYPE_EQNET_USER }
	Node types to identify connecting nodes. More...
enum	DataType { DATATYPE_EQ_CLIENT = net::DATATYPE_EQNET_CUSTOM, DATATYPE_EQ_SERVER, DATATYPE_EQ_CUSTOM = 1<<8 }
enum	Task {   TASK_NONE = EQ_BIT_NONE, TASK_DEFAULT = EQ_BIT1, TASK_CLEAR = EQ_BIT5, TASK_CULL = EQ_BIT9,   TASK_DRAW = EQ_BIT13, TASK_ASSEMBLE = EQ_BIT17, TASK_READBACK = EQ_BIT21, TASK_ALL = EQ_BIT_ALL }
	Tasks define the actions executed by a channel during rendering. More...
enum	WindowSystem {   WINDOW_SYSTEM_NONE = 0, WINDOW_SYSTEM_AGL, WINDOW_SYSTEM_GLX, WINDOW_SYSTEM_WGL,   WINDOW_SYSTEM_ALL }
Functions
std::ostream &	operator<< (std::ostream &os, const ChannelVisitor::Result result)
std::ostream &	operator<< (std::ostream &os, const ColorMask &mask)
std::ostream &	operator<< (std::ostream &os, const ConfigEvent *event)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const Event &event)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const Event::Type &type)
std::ostream &	operator<< (std::ostream &os, const ResizeEvent &event)
std::ostream &	operator<< (std::ostream &os, const PointerEvent &event)
std::ostream &	operator<< (std::ostream &os, const KeyEvent &event)
std::ostream &	operator<< (std::ostream &os, const Statistic &event)
std::ostream &	operator<< (std::ostream &os, const Eye &eye)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const Frame::Buffer buffer)
std::ostream &	operator<< (std::ostream &os, const FrameData *data)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const IAttrValue value)
std::ostream &	operator<< (std::ostream &os, const Image *image)
EQ_EXPORT bool	init (const int argc, char **argv, NodeFactory *nodeFactory)
	Initialize the Equalizer client library.
EQ_EXPORT bool	exit ()
	Deinitialize the Equalizer client library.
EQ_EXPORT Config *	getConfig (const int argc, char **argv)
	Convenience function to retrieve a configuration.
EQ_EXPORT void	releaseConfig (Config *config)
	Convenience function to release a configuration.
template<class T>
std::ostream &	operator<< (std::ostream &os, const Matrix4< T > &matrix)
std::ostream &	operator<< (std::ostream &os, const ServerChooseConfigPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ServerUseConfigPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ServerChooseConfigReplyPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ServerReleaseConfigPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ServerCreateConfigPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ConfigStartFrameReplyPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ConfigFrameFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const NodeCreatePipePacket *packet)
std::ostream &	operator<< (std::ostream &os, const NodeFrameStartPacket *packet)
std::ostream &	operator<< (std::ostream &os, const NodeFrameDrawFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const NodeFrameFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeCreateWindowPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeConfigInitPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeConfigInitReplyPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeFrameStartPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeFrameDrawFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeFrameNoDrawPacket *packet)
std::ostream &	operator<< (std::ostream &os, const PipeFrameFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const WindowCreateChannelPacket *packet)
std::ostream &	operator<< (std::ostream &os, const WindowConfigInitReplyPacket *packet)
std::ostream &	operator<< (std::ostream &os, const WindowFrameStartPacket *packet)
std::ostream &	operator<< (std::ostream &os, const WindowFrameDrawFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const WindowBarrierPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelConfigInitReplyPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelTaskPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelFrameStartPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelFrameDrawFinishPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelFrameReadbackPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelFrameTransmitPacket *packet)
std::ostream &	operator<< (std::ostream &os, const ChannelFrameAssemblePacket *packet)
std::ostream &	operator<< (std::ostream &os, const Pixel &pixel)
std::ostream &	operator<< (std::ostream &os, const PixelViewport &pvp)
ostream &	operator<< (ostream &os, const Projection &projection)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const Projection &)
std::ostream &	operator<< (std::ostream &os, const Range &range)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const RenderContext &ctx)
std::ostream &	operator<< (std::ostream &os, const Server *server)
std::ostream &	operator<< (std::ostream &os, const View &view)
std::ostream &	operator<< (std::ostream &os, const Viewport &vp)
ostream &	operator<< (ostream &os, const Wall &wall)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const Wall &wall)
std::ostream &	operator<< (std::ostream &os, const Window::DrawableConfig &config)
EQ_EXPORT void	debugGLError (const std::string &when, const GLenum error, const char *file, const int line)
EQ_EXPORT std::ostream &	operator<< (std::ostream &os, const WindowSystem ws)
Variables
struct eq::RGBHeader	packed

---

Enumeration Type Documentation

enum eq::KeyCode

Yet another key code table to report keys in a window system independent way.

Ordinary keys (letters, numbers, etc) are reported using the corresponding ascii code. The naming is oriented on the X11 keysym naming.

Definition at line 24 of file event.h.

enum eq::PointerButton

Mouse pointer button definition.

The enums are defined as masks, so that the state of all buttons can be OR'd using the same enum.

Definition at line 76 of file event.h.

enum eq::NodeType

Node types to identify connecting nodes.

Enumerator:

TYPE_EQ_SERVER

A server node.

Definition at line 13 of file client/nodeType.h.

enum eq::Task

Tasks define the actions executed by a channel during rendering.

The enum values are spaced apart to leave room for future additions without breaking binary backward compatibility.

Enumerator:

TASK_DEFAULT	ALL for leaf, else ASSEMBLE|READBACK.
TASK_CLEAR	Clear the framebuffer.
TASK_CULL	Cull data [unused].
TASK_DRAW	Draw data to the framebuffer.
TASK_ASSEMBLE	Combine input frames.
TASK_READBACK	Read results to output frames.

Definition at line 19 of file task.h.

---

Function Documentation

EQ_EXPORT bool eq::init	(	const int	argc,
		char **	argv,
		NodeFactory *	nodeFactory
	)

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.

References eq::net::init(), and eq::Global::setServer().

Here is the call graph for this function:

EQ_EXPORT bool eq::exit

(

)

Deinitialize the Equalizer client library.

De-initializes the Equalizer base classes.

Returns:

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

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

References eq::net::exit().

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

Here is the call graph for this function:

Here is the caller graph for this function:

EQ_EXPORT Config * eq::getConfig	(	const int	argc,
		char **	argv
	)

Convenience function to retrieve a configuration.

This function initializes a local client node, connects it to the server, and retrieves a configuration. On any failure everything is correctly deinitialized and 0 is returned.

Returns:

the pointer to a configuration, or 0 upon error.

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

Referenced by eq::Pipe::getFrameTime().

Here is the caller graph for this function:

EQ_EXPORT void eq::releaseConfig

(

Config *

config

)

Convenience function to release a configuration.

This function releases the configuration, disconnects the server, and stops the local client node.

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

References eq::Config::getServer(), and eq::base::RefPtr< T >::isValid().

Here is the call graph for this function: