eq::Client Class Reference

The client represents a network node in the cluster. More...

#include <client.h>

Inheritance diagram for eq::Client:

Collaboration diagram for eq::Client:

List of all members.

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.

bool hasCommands ()

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.

CommandQueue * getNodeThreadQueue ()

Return the command queue to the main node thread.

Protected Member Functions

virtual bool clientLoop ()

virtual bool exitClient ()

Detailed Description

The client represents a network node in the cluster.

Definition at line 35 of file lib/client/client.h.

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 93 of file lib/client/client.cpp.

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

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

Here is the call graph for this function:

Here is the caller 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 200 of file lib/client/client.cpp.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool eq::Client::hasCommands ( )

Returns:: true if the client has commands pending, false otherwise.

Definition at line 264 of file lib/client/client.cpp.

References eq::net::CommandQueue::isEmpty().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void eq::Client::processCommand ( )

Get and process one command from the node command queue.

Used internally to run node commands.

Definition at line 269 of file lib/client/client.cpp.

References eq::net::COMMAND_DISCARD, eq::net::COMMAND_ERROR, eq::net::COMMAND_HANDLED, eq::CommandQueue::pop(), and eq::net::Command::release().

Referenced by clientLoop(), and eqPly::EqPly::run().

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 57 of file lib/client/client.cpp.

References eq::net::Dispatcher::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 83 of file lib/client/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:

void eq::Client::setWindowSystem ( const WindowSystem windowSystem )

Set the window system for the client's message pump, used by non-threaded pipes.

For internal use only.

Definition at line 68 of file lib/client/client.cpp.

References EQINFO, EQWARN, eq::CommandQueue::getWindowSystem(), and eq::CommandQueue::setWindowSystem().

Here is the call graph for this function:

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

Return the command queue to the main node thread.

Definition at line 87 of file lib/client/client.h.

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

See also:: net::Node::clientLoop

Reimplemented from eq::net::Node.

Reimplemented in eqPly::EqPly.

Definition at line 244 of file lib/client/client.cpp.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Reimplemented from eq::net::Node.

Definition at line 259 of file lib/client/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:


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.
bool	hasCommands ()
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.
CommandQueue *	getNodeThreadQueue ()
	Return the command queue to the main node thread.
Protected Member Functions
virtual bool	clientLoop ()
virtual bool	exitClient ()