Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
admin/client.h
1 
2 /* Copyright (c) 2010-2013, Stefan Eilemann <eile@eyescale.ch>
3  *
4  * This library is free software; you can redistribute it and/or modify it under
5  * the terms of the GNU Lesser General Public License version 2.1 as published
6  * by the Free Software Foundation.
7  *
8  * This library is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11  * details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this library; if not, write to the Free Software Foundation, Inc.,
15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16  */
17 
18 #ifndef EQADMIN_CLIENT_H
19 #define EQADMIN_CLIENT_H
20 
21 #include <eq/admin/api.h>
22 #include <eq/admin/types.h>
23 #include <eq/fabric/client.h> // base class
24 #include <co/commandQueue.h> // member
25 
26 namespace eq
27 {
28 namespace admin
29 {
30 class Server;
31 
38 class Client : public fabric::Client
39 {
40 public:
42  EQADMIN_API Client();
43 
45  EQADMIN_API virtual ~Client();
46 
56  EQADMIN_API bool connectServer( ServerPtr server );
57 
65  EQADMIN_API bool disconnectServer( ServerPtr server );
66 
68  virtual co::CommandQueue* getMainThreadQueue()
69  { return &_mainThreadQueue; }
70 
71 private:
73  co::CommandQueue _mainThreadQueue;
74 
75  struct Private;
76  Private* _private; // placeholder for binary-compatible changes
77 
79  EQADMIN_API virtual co::NodePtr createNode( const uint32_t type );
80 };
81 }
82 }
83 
84 #endif // EQADMIN_CLIENT_H
EQADMIN_API Client()
Construct a new client.
virtual EQADMIN_API ~Client()
Destruct the client.
Defines admin API export macros.
virtual co::CommandQueue * getMainThreadQueue()
Definition: admin/client.h:68
A client represents a network node of the application in the cluster.
Definition: fabric/client.h:33
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.
The client represents the admin tool as a co::Node to the cluster.
Definition: admin/client.h:38