1 /***************************************************************************
2 * Copyright (C) 2006 by Gerd v. Egidy *
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. *
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. *
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 ***************************************************************************/
23 #include <boost/bind.hpp>
31 server_connection::server_connection(int _timeout)
32 : connection(), callbacks(__events_end)
34 set_timeout(_timeout);
40 server_connection::~server_connection()
42 // we want the connection_closed callbacks to be called before
45 do_callbacks(connection_deleted);
48 void server_connection::close()
53 do_callbacks(connection_closed);
57 /// get pointer to logging stream, returns NULL if no logging needed
58 std::ostream* server_connection::get_logstream(log_level_values level)
60 if (my_server != NULL)
62 std::ostream* ostr=my_server->get_logstream(level);
64 (*ostr) << "connection " << get_id() << ": ";
71 /// check if timeout is expired, close connection if so
72 void server_connection::check_timeout()
74 if (timeout != -1 && last_action_time+timeout < time(NULL))
76 LOGSTREAM(debug,"timeout on connection " << connection_id << ", closing");
81 /// reset the timeout, e.g. if something is received
82 void server_connection::reset_timeout()
84 last_action_time=time(NULL);
87 /** @brief add a callback
89 @param event event the function will be called at
90 @param func functor (see boost function) that will be called
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));
96 void server_connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
98 if (event == new_connection)
99 throw std::logic_error("new_connection callback not allowed for server_connections");
101 callbacks[event].push_back(func);
104 void server_connection::do_callbacks(callback_event_type event)
106 std::list<boost::function<void ()> >::iterator i,ie=callbacks[event].end();
107 for (i=callbacks[event].begin(); i != ie; i++)
112 : callbacks(__events_end)
114 set_default_timeout(30);
115 set_logging(NULL,none);
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++)
126 /** @brief add a callback
128 @param event event the function will be called at
129 @param func functor (see boost function) that will be called
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));
134 void server::add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func)
136 callbacks[event].push_back(func);
138 // add callback to all existing connections
139 if (event != new_connection)
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));
147 void server::do_callbacks(callback_event_type event, unsigned int conn_id)
149 std::list<boost::function<void (unsigned int)> >::iterator i,ie=callbacks[event].end();
150 for (i=callbacks[event].begin(); i != ie; i++)
154 int server::add_connection(server_connection* newconn)
156 unsigned int cid=next_id++;
157 newconn->set_id(cid);
158 newconn->set_server(this);
159 connections[cid]=newconn;
162 for(int e=connection_closed; e != __events_end; e++)
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));
169 LOGSTREAM(debug,"new connection accepted, id: " << cid);
171 do_callbacks(new_connection,cid);
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)
179 log_level=_log_level;
180 logstream=_logstream;
184 @brief Gets a connection by id
186 @param conn_id Connection ID
188 @retval Pointer to connection object
190 server_connection* server::get_connection(unsigned int conn_id)
192 std::map<unsigned int, server_connection*>::iterator p=connections.find(conn_id);
193 if (p==connections.end())
199 /// check for timeouts, remove closed connections. don't forget to call this from time to time.
200 void server::cleanup()
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();
206 for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie;)
208 if (i->second->is_closed() && !i->second->packet_available())
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");
214 connections.erase(i);
215 i=connections.begin();
216 ie=connections.end();
223 /** @brief get a complete data packet from any client. The packet is removed from the
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
229 bool server::get_packet(std::string& data, unsigned int& conn_id)
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
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))
238 LOGSTREAM(debug,"got packet (" << data.size() << " bytes) from connection " << i->first);
247 /// get pointer to logging stream, returns NULL if no logging needed
248 std::ostream* server::get_logstream(log_level_values level)
250 if (logstream && log_level >= level)