libt2n: (gerd) basic command handling (still some todos)
[libt2n] / src / socket_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_SOCKET_CLIENT
20 #define __LIBT2N_SOCKET_CLIENT
21
22 #include "client.hxx"
23 #include "socket_handler.hxx"
24
25 namespace libt2n
26 {
27 /** @brief a connection from client to server using sockets.
28
29     Use this class to connect from a client to a server.
30  */
31 class socket_client_connection : public client_connection, public socket_handler
32 {
33     public:
34         static const int max_retries_default=3;
35
36     private:
37         void real_write(const std::string& data)
38             { socket_write(data); }
39
40         void connect();
41
42         int max_retries;
43
44         std::string path;
45         std::string server;
46         int port;
47
48     public:
49         socket_client_connection(const std::string& _server, int _port, int _max_retries=max_retries_default);
50         socket_client_connection(const std::string& _path, int _max_retries=max_retries_default);
51
52         /** @brief read data from the socket and copy it into buffer
53             @param usec_timeout wait until new data is found, max timeout usecs.
54                     -1: wait endless
55                     NULL: no timeout
56             @retval true if new data was found (does not mean that the received data 
57                     is a complete packet though)
58         */
59         bool fill_buffer(long long usec_timeout=-1)
60             { return socket_handler::fill_buffer(buffer,usec_timeout); }
61
62         void close();
63 };
64
65 }
66
67 #endif