eq::Client Class Reference

#include <client.h>

Inheritance diagram for eq::Client:

Inheritance graph
[legend]
Collaboration diagram for eq::Client:

Collaboration graph
[legend]

List of all members.


Detailed Description

The client represents a network node in the cluster.

Definition at line 20 of file client.h.


Public Member Functions

 Client ()
 Constructs a new client.
virtual ~Client ()
 Destructs the client.
bool connectServer (ServerPtr server)
 Open and connect an Equalizer server to the local client.
bool disconnectServer (ServerPtr server)
 Disconnect and close the connection of an Equalizer server to the local client.
void processCommand ()
 Get and process one command from the node command queue.
virtual bool listen ()
virtual bool stopListening ()
void setWindowSystem (const WindowSystem windowSystem)
 Set the window system for the client's message pump, used by non-threaded pipes.
CommandQueuegetNodeThreadQueue ()
 Return the command queue to the main node thread.

Protected Member Functions

virtual bool clientLoop ()
virtual bool exitClient ()

Member Function Documentation

bool eq::Client::connectServer ( ServerPtr  server  ) 

Open and connect an Equalizer server to the local client.

Parameters:
server the server.
Returns:
true if the server was connected, false if not.

Definition at line 81 of file client.cpp.

References eq::net::Node::connect(), eq::base::RefPtr< T >::get(), and eq::Global::getServer().

Here is the call graph for this function:

bool eq::Client::disconnectServer ( ServerPtr  server  ) 

Disconnect and close the connection of an Equalizer server to the local client.

Parameters:
server the server.
Returns:
true if the server was disconnected, false if not.

Definition at line 217 of file client.cpp.

References eq::net::Node::disconnect(), eq::CommandQueue::flush(), and eq::base::RefPtr< T >::get().

Here is the call graph for this function:

void eq::Client::processCommand (  ) 

Get and process one command from the node command queue.

Used internally to run nonthreaded commands.

Definition at line 281 of file client.cpp.

References eq::CommandQueue::pop(), and eq::net::CommandQueue::release().

Referenced by clientLoop().

Here is the call graph for this function:

Here is the caller graph for this function:

bool eq::Client::listen (  )  [virtual]

See also:
net::Node::listen()

Reimplemented from eq::net::Node.

Definition at line 47 of file client.cpp.

References eq::net::Node::listen(), and eq::net::Base::registerCommand().

Here is the call graph for this function:

bool eq::Client::stopListening (  )  [virtual]

See also:
net::Node::stopListening()

Reimplemented from eq::net::Node.

Definition at line 71 of file client.cpp.

References eq::net::Node::stopListening().

Referenced by ~Client().

Here is the call graph for this function:

Here is the caller graph for this function:

CommandQueue* eq::Client::getNodeThreadQueue (  )  [inline]

Return the command queue to the main node thread.

Definition at line 69 of file client.h.

bool eq::Client::clientLoop (  )  [protected, virtual]

See also:
net::Node::clientLoop

Reimplemented from eq::net::Node.

Definition at line 261 of file client.cpp.

References eq::CommandQueue::flush(), and processCommand().

Here is the call graph for this function:

bool eq::Client::exitClient (  )  [protected, virtual]

See also:
net::Node::exitClient().

Reimplemented from eq::net::Node.

Definition at line 276 of file client.cpp.

References eq::exit(), and eq::net::Node::exitClient().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Generated on Sat Dec 6 12:01:44 2008 for Equalizer 0.6 by  doxygen 1.5.5