libt2n: (gerd) improve exports
[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 struct sockaddr;
26
27 namespace libt2n
28 {
29 /** @brief a connection from client to server using sockets.
30
31     Use this class to connect from a client to a server.
32  */
33 class socket_client_connection : public client_connection, public socket_handler
34 {
35     public:
36         static const int max_retries_default=3;
37         static const long long connect_timeout_usec_default=30000000;
38
39     private:
40         void real_write(const std::string& data)
41             { socket_write(data); }
42
43         void tcp_connect(int max_retries);
44         void unix_connect(int max_retries);
45         void connect_with_timeout(struct sockaddr *sock_addr,unsigned int sockaddr_size);
46
47         int max_retries;
48         long long connect_timeout_usec;
49
50         std::string path;
51         std::string server;
52         int port;
53
54         std::ostream* get_logstream(log_level_values level)
55             { return client_connection::get_logstream(level); }
56
57     public:
58         socket_client_connection(int _port, const std::string& _server="127.0.0.1", 
59             long long _connect_timeout_usec=connect_timeout_usec_default, 
60             int _max_retries=max_retries_default);
61         socket_client_connection(const std::string& _path,
62             long long _connect_timeout_usec=connect_timeout_usec_default, 
63             int _max_retries=max_retries_default);
64
65         /** @brief read data from the socket and copy it into buffer
66             @param usec_timeout wait until new data is found, max timeout usecs.
67                   -1: wait endless
68                    0: return instantly
69             @param usec_timeout_remaining if non-NULL the function will write the
70                   not used time to the given target
71             @retval true if new data was found (does not mean that the received data 
72                     is a complete packet though)
73         */
74         bool fill_buffer(long long usec_timeout=-1, long long *usec_timeout_remaining=NULL)
75             { return socket_handler::fill_buffer(buffer,usec_timeout,usec_timeout_remaining); }
76
77         void close();
78 };
79
80 }
81
82 #endif