libftdi, libt2n: (tomj) fix build when doxygen is not installed
[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 recv_buffer_size=2048;
36         static const unsigned int write_block_size=4096;
37
38         socket_type_value socket_type;
39
40         bool data_waiting(long long usec_timeout,long long *timeout_remaining=NULL);
41
42     protected:
43         int sock;
44
45         socket_handler(int _sock, socket_type_value _socket_type)
46             { sock=_sock; socket_type=_socket_type; }
47
48         void set_socket_options(int sock);
49
50         virtual std::ostream* get_logstream(log_level_values level)
51             { return NULL; }
52
53         void socket_write(const std::string& data);
54
55         virtual void close();
56
57         bool fill_buffer(std::string& buffer, long long usec_timeout, long long*timeout_remaining=NULL);
58         bool fill_buffer(std::string& buffer);
59
60     public:
61         /// is this a tcp or udp socket connection
62         socket_type_value get_type()
63             { return socket_type; }
64
65         bool is_closed();
66 };
67
68 }
69
70 #endif