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 | |
| Server () | |
| Construct a new server. More... | |
| Config * | chooseConfig (const fabric::ConfigParams ¶meters) |
| Choose a configuration on the server. More... | |
| void | releaseConfig (Config *config) |
| Release a configuration. More... | |
| bool | shutdown () |
Internal | |
| virtual void | setClient (ClientPtr client) |
| co::CommandQueue * | getMainThreadQueue () |
| 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 () |
Friends | |
| class | Client |
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 38 of file client/server.h.
Constructor & Destructor Documentation
| eq::Server::Server | ( | ) |
Construct a new server.
- Version
- 1.0
Member Function Documentation
| 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
| 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
| bool eq::Server::shutdown | ( | ) |
- Warning
- Experimental - may not be supported in the future
The documentation for this class was generated from the following file:
