libt2n: (gerd) add lots of error handling code, unit tests for this error handling...
[libt2n] / src / socket_handler.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_HANDLER
20 #define __LIBT2N_SOCKET_HANDLER
21
22 #include <iostream>
23
24 #include "types.hxx"
25
26 namespace libt2n
27 {
28
29 /** @brief handles socket based communication.
30     Don't use directly, use socket_server or socket_client_connection instead.
31 */
32 class socket_handler
33 {
34     private:
35         static const unsigned int default_recv_buffer_size=2048;
36         static const unsigned int default_write_block_size=4096;
37         static const long long default_write_timeout=30000000;
38
39         socket_type_value socket_type;
40
41         bool data_waiting(long long usec_timeout,long long *timeout_remaining=NULL);
42         void wait_ready_to_write(int socket, long long write_block_timeout);
43
44     protected:
45         int sock;
46         unsigned int recv_buffer_size;
47         unsigned int write_block_size;
48         long long write_timeout;
49
50         socket_handler(int _sock, socket_type_value _socket_type);
51
52         void set_socket_options(int sock);
53
54         virtual std::ostream* get_logstream(log_level_values level)
55             { return NULL; }
56
57         void socket_write(const std::string& data);
58
59         virtual void close();
60
61         bool fill_buffer(std::string& buffer, long long usec_timeout, long long*timeout_remaining=NULL);
62         bool fill_buffer(std::string& buffer);
63
64     public:
65         /// is this a tcp or unix socket connection
66         socket_type_value get_type()
67             { return socket_type; }
68
69         bool is_closed();
70
71         void set_recv_buffer_size(unsigned int new_recv_buffer_size);
72         void set_write_block_size(unsigned int new_write_block_size);
73         void set_write_timeout(long long new_write_timeout);
74
75         unsigned int get_recv_buffer_size() const { return recv_buffer_size; }
76         unsigned int get_write_block_size() const { return write_block_size; }
77         long long get_write_timeout() const { return write_timeout; }
78 };
79
80 }
81
82 #endif