| 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_SERVER |
| 20 | #define __LIBT2N_SERVER |
| 21 | |
| 22 | #include <iostream> |
| 23 | #include <string> |
| 24 | #include <map> |
| 25 | #include <vector> |
| 26 | #include <list> |
| 27 | |
| 28 | #include <boost/function.hpp> |
| 29 | |
| 30 | #include "connection.hxx" |
| 31 | #include "types.hxx" |
| 32 | |
| 33 | namespace libt2n |
| 34 | { |
| 35 | |
| 36 | class server; |
| 37 | |
| 38 | /** |
| 39 | @brief connection on a server |
| 40 | |
| 41 | on a server every connection to a client is represented as server_connection. |
| 42 | a server_connection is abstract, derived classes like socket_server_connection are used. |
| 43 | */ |
| 44 | class server_connection : public connection |
| 45 | { |
| 46 | friend class server; |
| 47 | |
| 48 | private: |
| 49 | int timeout; |
| 50 | int last_action_time; |
| 51 | unsigned int connection_id; |
| 52 | |
| 53 | void set_server(server* _my_server) |
| 54 | { my_server=_my_server; } |
| 55 | |
| 56 | void set_id(unsigned int _connection_id) |
| 57 | { connection_id=_connection_id; } |
| 58 | |
| 59 | protected: |
| 60 | server *my_server; |
| 61 | |
| 62 | server_connection(int _timeout); |
| 63 | |
| 64 | std::ostream* get_logstream(log_level_values level); |
| 65 | |
| 66 | public: |
| 67 | void check_timeout(); |
| 68 | void reset_timeout(); |
| 69 | void set_timeout(int _timeout) |
| 70 | { timeout=_timeout; } |
| 71 | |
| 72 | /// get the id of this connection within the server object |
| 73 | unsigned int get_id() |
| 74 | { return connection_id; } |
| 75 | |
| 76 | void add_callback(callback_event_type event, const boost::function<void ()>& func); |
| 77 | }; |
| 78 | |
| 79 | /** |
| 80 | @brief server base class |
| 81 | |
| 82 | constitutes a server. is abstract, use derived classes like socket_server. |
| 83 | */ |
| 84 | class server |
| 85 | { |
| 86 | private: |
| 87 | int default_timeout; |
| 88 | log_level_values log_level; |
| 89 | std::ostream *logstream; |
| 90 | |
| 91 | /// vector initialized for all callback-types, all elements in each list will be called |
| 92 | std::vector<std::list<boost::function<void (unsigned int)> > > callbacks; |
| 93 | |
| 94 | unsigned int next_id; |
| 95 | |
| 96 | protected: |
| 97 | std::map<unsigned int, server_connection*> connections; |
| 98 | |
| 99 | server(); |
| 100 | |
| 101 | virtual bool fill_connection_buffers(void)=0; |
| 102 | |
| 103 | int add_connection(server_connection* newconn); |
| 104 | |
| 105 | void do_callbacks(callback_event_type event, unsigned int conn_id); |
| 106 | |
| 107 | public: |
| 108 | virtual ~server(); |
| 109 | |
| 110 | /// set the default timeout for new client connections |
| 111 | void set_default_timeout(int _default_timeout) |
| 112 | { default_timeout=_default_timeout; } |
| 113 | |
| 114 | /// get the current default timeout for client connections |
| 115 | int get_default_timeout(void) |
| 116 | { return default_timeout; } |
| 117 | |
| 118 | void set_logging(std::ostream *_logstream, log_level_values _log_level); |
| 119 | |
| 120 | server_connection* get_connection(unsigned int conn_id); |
| 121 | |
| 122 | void add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func); |
| 123 | |
| 124 | /** @brief look for new data and store it in the local buffer |
| 125 | @param usec_timeout wait until new data is found, max timeout usecs. |
| 126 | -1: wait endless |
| 127 | 0: return instantly |
| 128 | @param usec_timeout_remaining if non-NULL the function will write the |
| 129 | not used time to the given target |
| 130 | @retval true if new data was found (does not mean that the received data |
| 131 | is a complete packet though) |
| 132 | */ |
| 133 | virtual bool fill_buffer(long long usec_timeout=-1, long long* timeout_remaining=NULL)=0; |
| 134 | |
| 135 | void cleanup(); |
| 136 | |
| 137 | /** @brief get a complete data packet from any client. The packet is removed from the |
| 138 | connection buffer. |
| 139 | @param[out] data the data package |
| 140 | @retval true if packet found |
| 141 | */ |
| 142 | bool get_packet(std::string& data) |
| 143 | { unsigned int x; return get_packet(data,x); } |
| 144 | |
| 145 | bool get_packet(std::string& data, unsigned int& conn_id); |
| 146 | |
| 147 | std::ostream* get_logstream(log_level_values level); |
| 148 | }; |
| 149 | |
| 150 | } |
| 151 | |
| 152 | #endif |