The client represents the admin tool as a co::Node to the cluster. More...
#include <client.h>
Inheritance diagram for eq::admin::Client:
Collaboration diagram for eq::admin::Client:
Public Member Functions | |
| EQADMIN_API | Client () |
| Construct a new client. | |
| virtual EQADMIN_API | ~Client () |
| Destruct the client. | |
| EQADMIN_API bool | connectServer (ServerPtr server) |
| Open and connect an Equalizer server to the local client. | |
| EQADMIN_API bool | disconnectServer (ServerPtr server) |
| Disconnect and close the connection to an Equalizer server. | |
| virtual co::CommandQueue * | getMainThreadQueue () |
Detailed Description
The client represents the admin tool as a co::Node to the cluster.
The methods initLocal() and exitLocal() should be used to set up and exit the listening node instance for each application process.
Definition at line 38 of file admin/client.h.
Constructor & Destructor Documentation
| EQADMIN_API eq::admin::Client::Client | ( | ) |
| virtual EQADMIN_API eq::admin::Client::~Client | ( | ) | [virtual] |
Member Function Documentation
| EQADMIN_API bool eq::admin::Client::connectServer | ( | ServerPtr | server | ) |
Open and connect an Equalizer server to the local client.
The client has to be in the listening state, see initLocal().
- Parameters:
-
server the server.
- Returns:
- true if the server was connected, false if not.
- Version:
- 1.0
| EQADMIN_API bool eq::admin::Client::disconnectServer | ( | ServerPtr | server | ) |
Disconnect and close the connection to an Equalizer server.
- Parameters:
-
server the server.
- Returns:
- true if the server was disconnected, false if not.
- Version:
- 1.0
| virtual co::CommandQueue* eq::admin::Client::getMainThreadQueue | ( | ) | [inline, virtual] |
- Returns:
- the command queue to the main node thread.
Implements eq::fabric::Client.
Definition at line 68 of file admin/client.h.
The documentation for this class was generated from the following file:
