6bc1cba9be811374e1e9d806bad9c00df78b9d99
[libt2n] / src / server.cpp
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
20 #include <sstream>
21
22 #include <boost/bind.hpp>
23
24 #include "server.hxx"
25 #include "log.hxx"
26 #include "t2n_exception.hxx"
27
28 namespace libt2n
29 {
30
31 server_connection::server_connection(int _timeout)
32     : connection(), callbacks(__events_end)
33 {
34     set_timeout(_timeout);
35     reset_timeout();
36     connection_id=0;
37     my_server=0;
38 }
39
40 server_connection::~server_connection()
41 {
42     // we want the connection_closed callbacks to be called before
43     close();
44
45     do_callbacks(connection_deleted);
46 }
47
48 void server_connection::close()
49 {
50     if (!is_closed())
51     {
52         connection::close();
53         do_callbacks(connection_closed);
54     }
55 }
56
57 /// get pointer to logging stream, returns NULL if no logging needed
58 std::ostream* server_connection::get_logstream(log_level_values level)
59 {
60     if (my_server != NULL)
61     {
62         std::ostream* ostr=my_server->get_logstream(level);
63         if (ostr != NULL)
64             (*ostr) << "connection " << get_id() << ": ";
65         return ostr;
66     }
67     else
68         return NULL;
69 }
70
71 /// check if timeout is expired, close connection if so
72 void server_connection::check_timeout()
73 {
74     if (timeout != -1 && last_action_time+timeout < time(NULL))
75     {
76         LOGSTREAM(debug,"timeout on connection " << connection_id << ", closing");
77         this->close();
78     }
79 }
80
81 /// reset the timeout, e.g. if something is received
82 void server_connection::reset_timeout()
83 {
84     last_action_time=time(NULL);
85 }
86
87 /** @brief add a callback
88
89     @param event event the function will be called at
90     @param func functor (see boost function) that will be called
91
92     @example use boost::bind to bind to member functions and parameters like this:
93         17 is a fixed parameter that is always added to the call
94         c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));
95 */
96 void server_connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
97 {
98     if (event == new_connection)
99         throw t2n_parameter_error("new_connection callback not allowed for server_connections");
100
101     callbacks[event].push_back(func);
102 }
103
104 void server_connection::do_callbacks(callback_event_type event)
105 {
106     std::list<boost::function<void ()> >::iterator i,ie=callbacks[event].end();
107     for (i=callbacks[event].begin(); i != ie; i++)
108         (*i)();
109 }
110
111 server::server()
112     : callbacks(__events_end)
113 {
114     set_default_timeout(30);
115     set_logging(NULL,none);
116     next_id=1;
117 }
118
119 server::~server()
120 {
121     std::map<unsigned int, server_connection*>::iterator ie=connections.end();
122     for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
123         delete i->second;
124 }
125
126 /** @brief add a callback
127
128     @param event event the function will be called at
129     @param func functor (see boost function) that will be called
130
131     @example use boost::bind to bind to member functions like this:
132         s.add_callback(new_connection,bind(&my_class::func_to_call_back, boost::ref(*this), _1));
133 */
134 void server::add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func)
135 {
136     callbacks[event].push_back(func);
137
138     // add callback to all existing connections
139     if (event != new_connection)
140     {
141         std::map<unsigned int, server_connection*>::iterator ie=connections.end();
142         for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
143             i->second->add_callback(event,bind(func, i->first));
144     }
145 }
146
147 void server::do_callbacks(callback_event_type event, unsigned int conn_id)
148 {
149     std::list<boost::function<void (unsigned int)> >::iterator i,ie=callbacks[event].end();
150     for (i=callbacks[event].begin(); i != ie; i++)
151         (*i)(conn_id);
152 }
153
154 int server::add_connection(server_connection* newconn)
155 {
156     unsigned int cid=next_id++;
157     newconn->set_id(cid);
158     newconn->set_server(this);
159     connections[cid]=newconn;
160
161     // add all callbacks
162     for(int e=connection_closed; e != __events_end; e++)
163     {
164         std::list<boost::function<void (unsigned int)> >::iterator i,ie=callbacks[e].end();
165         for (i=callbacks[e].begin(); i != ie; i++)
166             newconn->add_callback(static_cast<callback_event_type>(e),bind(*i,cid));
167     }
168
169     LOGSTREAM(debug,"new connection accepted, id: " << cid);
170
171     do_callbacks(new_connection,cid);
172
173     return cid;
174 }
175
176 /// activate logging to the given stream. everything above the given level is logged.
177 void server::set_logging(std::ostream *_logstream, log_level_values _log_level)
178 {
179     log_level=_log_level;
180     logstream=_logstream;
181 }
182
183 /**
184     @brief Gets a connection by id
185     
186     @param conn_id Connection ID
187     
188     @retval Pointer to connection object
189 */
190 server_connection* server::get_connection(unsigned int conn_id)
191 {
192     std::map<unsigned int, server_connection*>::iterator p=connections.find(conn_id);
193     if (p==connections.end())
194         return NULL;
195     else
196         return p->second;
197 }
198
199 /// check for timeouts, remove closed connections. don't forget to call this from time to time.
200 void server::cleanup()
201 {
202     std::map<unsigned int, server_connection*>::iterator ie=connections.end();
203     for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
204         i->second->check_timeout();
205
206     for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie;)
207     {
208         if (i->second->is_closed() && !i->second->packet_available())
209         {
210             // closed and no usable data in buffer -> remove
211             LOGSTREAM(debug,"removing conneciton " << i->first << " because it is closed and no more data waiting");
212
213             delete i->second;
214             connections.erase(i);
215             i=connections.begin();
216             ie=connections.end();
217         }
218         else
219             i++;
220     }
221 }
222
223 /** @brief get a complete data packet from any client. The packet is removed from the
224             connection buffer.
225     @param[out] data the data package
226     @param[out] conn_id the connection id we got this packet from
227     @retval true if packet found
228 */
229 bool server::get_packet(std::string& data, unsigned int& conn_id)
230 {
231     // todo: this is somehow unfair: the first connections in the map get checked more
232     // often than the others and can thus block them out
233
234     std::map<unsigned int, server_connection*>::iterator ie=connections.end();
235     for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
236         if (i->second->get_packet(data))
237         {
238             LOGSTREAM(debug,"got packet (" << data.size() << " bytes) from connection " << i->first);
239
240             conn_id=i->first;
241             return true;
242         }
243
244     return false;
245 }
246
247 /// get pointer to logging stream, returns NULL if no logging needed
248 std::ostream* server::get_logstream(log_level_values level)
249 {
250     if (logstream && log_level >= level)
251         return logstream;
252     else
253         return NULL;
254 }
255 };