libt2n: (gerd) more documentation-polishing
[libt2n] / src / command_client.hxx
1 /***************************************************************************
2  *   Copyright (C) 2006 by Gerd v. Egidy                                   *
3  *   gve@intra2net.com                                                     *
4  *                                                                         *
5  *   This library is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU Lesser General Public License version   *
7  *   2.1 as published by the Free Software Foundation.                     *
8  *                                                                         *
9  *   This library is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU Lesser General Public License for more details.                   *
13  *                                                                         *
14  *   You should have received a copy of the GNU Lesser General Public      *
15  *   License along with this program; if not, write to the                 *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19 #ifndef __LIBT2N_COMMAND_CLIENT
20 #define __LIBT2N_COMMAND_CLIENT
21
22 #include <functional>
23 #include <string>
24
25 #include "client.hxx"
26 #include "container.hxx"
27
28 namespace libt2n
29 {
30
31 /// a client sending out commands to a server
32 class command_client
33 {
34     public:
35         static const long long command_timeout_usec_default=90000000;
36         static const long long hello_timeout_usec_default=30000000;
37
38     private:
39         client_connection *c;
40
41         long long hello_timeout_usec;
42         long long command_timeout_usec;
43
44         void read_hello();
45         std::string read_packet(const long long &usec_timeout);
46         bool check_hello(const std::string& hellostr);
47
48         std::auto_ptr<t2n_exception> constructorException;
49
50     public:
51         command_client(client_connection* _c,
52             long long _command_timeout_usec=command_timeout_usec_default,
53             long long _hello_timeout_usec=hello_timeout_usec_default);
54         virtual ~command_client() {}
55
56         void replace_connection(client_connection* _c);
57
58         void send_command(command* cmd, result_container &res);
59
60         void set_command_timeout_usec(long long _command_timeout_usec=command_timeout_usec_default)
61             { command_timeout_usec=_command_timeout_usec; }
62         void set_hello_timeout_usec(long long _hello_timeout_usec=hello_timeout_usec_default)
63             { hello_timeout_usec=_hello_timeout_usec; }
64         long long get_command_timeout_usec(void)
65             { return command_timeout_usec; }
66         long long get_hello_timeout_usec(void)
67             { return hello_timeout_usec; }
68         bool is_connection_closed(void)
69             { return c->is_closed(); }
70         t2n_exception* get_constuctor_exception(void)
71             { return constructorException.get(); }
72 };
73
74 }
75
76 #endif
77