Equalizer  2.0.0
Parallel Rendering Framework
eq::fabric::Client Class Referenceabstract

A client represents a network node of the application in the cluster. More...

#include <client.h>

+ Inheritance diagram for eq::fabric::Client:
+ Collaboration diagram for eq::fabric::Client:

Public Member Functions

EQFABRIC_API bool connectServer (co::NodePtr server)
 Open and connect an Equalizer server to the local client. More...
 
EQFABRIC_API bool disconnectServer (co::NodePtr server)
 Disconnect and close the connection to an Equalizer server. More...
 
EQFABRIC_API void processCommand (const uint32_t timeout=LB_TIMEOUT_INDEFINITE)
 Get and process one pending command from the node command queue. More...
 
virtual co::CommandQueue * getMainThreadQueue ()=0
 
virtual EQFABRIC_API bool dispatchCommand (co::ICommand &command)
 

Protected Member Functions

EQFABRIC_API Client ()
 Construct a new client.
 
virtual EQFABRIC_API ~Client ()
 Destruct the client.
 

Detailed Description

A client represents a network node of the application in the cluster.

Definition at line 33 of file fabric/client.h.

Member Function Documentation

EQFABRIC_API bool eq::fabric::Client::connectServer ( co::NodePtr  server)

Open and connect an Equalizer server to the local client.

The client has to be in the listening state, see initLocal().

Parameters
serverthe server.
Returns
true if the server was connected, false if not.
Version
1.0
EQFABRIC_API bool eq::fabric::Client::disconnectServer ( co::NodePtr  server)

Disconnect and close the connection to an Equalizer server.

Parameters
serverthe server.
Returns
true if the server was disconnected, false if not.
Version
1.0
virtual co::CommandQueue* eq::fabric::Client::getMainThreadQueue ( )
pure virtual
Returns
the command queue to the main node thread.

Implemented in eq::Client.

EQFABRIC_API void eq::fabric::Client::processCommand ( const uint32_t  timeout = LB_TIMEOUT_INDEFINITE)

Get and process one pending command from the node command queue.

Version
1.0

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