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 ***************************************************************************/
25 #include <netinet/in.h>
27 #include "connection.hxx"
32 connection::~connection()
34 // we want the connection_closed callbacks to be called before
35 // FIXME: Functios is virtual
38 do_callbacks(connection_deleted);
41 void connection::close()
46 do_callbacks(connection_closed);
50 /// get the number of bytes being available as next complete packet
51 connection::packet_size_indicator connection::bytes_available()
53 // no size information -> no packet
54 if (buffer.size() < sizeof(packet_size_indicator))
57 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data())));
59 // enough data for one packet in buffer?
60 if (buffer.size() < sizeof(packet_size_indicator)+psize)
63 // ok, full packet there
67 /** @brief read a complete data packet from the buffer. The packet is removed from the
69 @param[out] data the data package
70 @retval true if packet found
72 bool connection::get_packet(std::string& data)
74 packet_size_indicator psize;
76 if ((psize=bytes_available()))
78 data.assign(buffer,sizeof(packet_size_indicator),psize);
79 buffer.erase(0,sizeof(packet_size_indicator)+psize);
86 /** @brief get (maybe incomplete) data of the next packet from the buffer. Does not remove the data
87 from the connection buffer.
88 @param[out] data the data package
89 @retval full size of the packet when it will be complete
91 unsigned int connection::peek_packet(std::string& data)
93 // no size information -> no packet
94 if (buffer.size() < sizeof(packet_size_indicator))
97 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data())));
99 // not the full data available?
100 packet_size_indicator currsize=psize;
101 if (buffer.size() < currsize+sizeof(packet_size_indicator))
102 currsize=buffer.size()-sizeof(packet_size_indicator);
104 data.assign(buffer,sizeof(packet_size_indicator),currsize);
109 /// remove all data from buffer that is not a complete packet
110 void connection::remove_incomplete_packets()
112 std::string::size_type p=0;
113 std::string::size_type end=buffer.size();
117 // not enough space for size information -> no packet
118 if (p+sizeof(packet_size_indicator) > end)
121 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data()+p)));
123 if (p+sizeof(packet_size_indicator)+psize > end)
130 // move p to where the next packet will start
131 p+=sizeof(packet_size_indicator)+psize;
137 // incomplete packets there, remove them
142 /// send a blob to the peer
143 void connection::write(const std::string& data)
145 // prepend packet size to data
146 packet_size_indicator psize=htonl(data.size());
147 std::string send_data(data);
148 send_data.insert(0,(char*)&psize,sizeof(packet_size_indicator));
150 real_write(send_data);
153 /** @brief add a callback
155 @param event event the function will be called at
156 @param func functor (see boost function) that will be called
158 @note use boost::bind to bind to member functions and parameters like this:
159 17 is a fixed parameter that is always added to the call
160 c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));
162 void connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
164 callbacks[event].push_back(func);
167 /** @brief an event has occured, execute the callbacks that are registered for this event
169 @param event event type that has occured
171 void connection::do_callbacks(callback_event_type event)
173 std::list<boost::function<void ()> >::iterator i,ie=callbacks[event].end();
174 for (i=callbacks[event].begin(); i != ie; i++)
178 /** @brief get the callbacks in place for one event
180 @param event event the callbacks should be registered for
181 @return std::list of functors (boost::function) with the callbacks
183 @note if you want to get the callbacks for all events, loop from 0 to __events_end
185 std::list<boost::function<void ()> > connection::get_callback_list(callback_event_type event)
187 return callbacks[event];
190 /** @brief reopen a already closed connection, removes incomplete packets from the buffer
192 @note Only call when the connection is closed.
194 @note Justs cares about the data of connection, reconnecting has to be
195 done in a derived class.
197 void connection::reopen()
200 throw std::logic_error("connection::reopen() called with connection still open");
204 // incomplete buffer data is worthless with a new connection
205 remove_incomplete_packets();
207 do_callbacks(new_connection);