eq::Server Class Reference

Proxy object for the connection to an Equalizer server. More...

#include <server.h>

Inheritance diagram for eq::Server:

Collaboration diagram for eq::Server:

Public Member Functions
EQ_API	Server ()
	Construct a new server. More...
EQ_API Config *	chooseConfig (const fabric::ConfigParams &parameters)
	Choose a configuration on the server. More...
EQ_API void	releaseConfig (Config *config)
	Release a configuration. More...
EQ_API bool	shutdown ()
Internal
virtual void	setClient (ClientPtr client)
EQ_API co::CommandQueue *	getMainThreadQueue ()
EQ_API co::CommandQueue *	getCommandThreadQueue ()
Public Member Functions inherited from eq::fabric::Server< Client, Server, Config, NodeFactory, co::Node, ServerVisitor >
ClientPtr	getClient ()
ConstClientPtr	getClient () const
const Configs &	getConfigs () const
EQFABRIC_INL VisitorResult	accept (ServerVisitor &visitor)
	Traverse this server and all children using a server visitor. More...
EQFABRIC_INL VisitorResult	accept (ServerVisitor &visitor) const
	Const-version of accept(). More...
NodeFactory *	getNodeFactory ()

Additional Inherited Members
Public Types inherited from eq::fabric::Server< Client, Server, Config, NodeFactory, co::Node, ServerVisitor >
typedef lunchbox::RefPtr< Client >	ClientPtr
	A reference-counted pointer to the client. More...
typedef lunchbox::RefPtr < const Client >	ConstClientPtr
	A reference-counted const pointer to the client. More...
typedef std::vector< Config * >	Configs
	A vector of config pointers. More...
typedef NodeFactory	NodeFactory
	The node factory. More...
Protected Member Functions inherited from eq::fabric::Server< Client, Server, Config, NodeFactory, co::Node, ServerVisitor >
	Server (NodeFactory *nodeFactory)
void	_addConfig (Config *config)
bool	_removeConfig (Config *config)

Detailed Description

Proxy object for the connection to an Equalizer server.

The server manages the configurations for Equalizer applications. This proxy object is used to connect to a server and obtain and release a Config from the server.

See Also

fabric::Server, Client::connectServer()

Definition at line 40 of file server.h.

Constructor & Destructor Documentation

EQ_API eq::Server::Server

(

)

Construct a new server.

Version

1.0

Member Function Documentation

EQ_API Config* eq::Server::chooseConfig

(

const fabric::ConfigParams &

parameters

)

Choose a configuration on the server.

Parameters

parameters

the configuration parameters

Returns

The chosen config, or 0 if no matching config was found.

See Also

ConfigParams

Version

1.0

EQ_API void eq::Server::releaseConfig

(

Config *

config

)

Release a configuration.

The passed configuration will be destroyed by this function and is no longer valid after the call.

Parameters

config

the configuration.

Version

1.0

EQ_API bool eq::Server::shutdown

(

)

Warning

Experimental - may not be supported in the future

---

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

• server.h