Equalizer  1.2.1
Public Member Functions | Protected Member Functions
eq::fabric::Client Class Reference

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:

List of all members.

Public Member Functions

bool connectServer (co::NodePtr server)
 Open and connect an Equalizer server to the local client.
bool disconnectServer (co::NodePtr server)
 Disconnect and close the connection to an Equalizer server.
void processCommand (const uint32_t timeout=EQ_TIMEOUT_INDEFINITE)
 Get and process one pending command from the node command queue.
virtual co::CommandQueuegetMainThreadQueue ()=0
virtual bool dispatchCommand (co::Command &command)
 Dispatches a packet to the registered command queue.

Protected Member Functions

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

Detailed Description

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

Definition at line 30 of file include/eq/fabric/client.h.


Member Function Documentation

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

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 bool eq::fabric::Client::dispatchCommand ( co::Command command) [virtual]

Dispatches a packet to the registered command queue.

Parameters:
commandthe command.
Returns:
the result of the operation.
See also:
Command::invoke

Reimplemented from co::LocalNode.

Returns:
the command queue to the main node thread.

Implemented in eq::Client.

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

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

Version:
1.0

Referenced by eqPly::EqPly::run().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following file:
Generated on Fri Jun 8 2012 15:44:35 for Equalizer 1.2.1 by  doxygen 1.8.0