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 // Run close() manually since it's a virtual function
35 // and we are in the destructor.
39 do_callbacks(connection_closed);
42 do_callbacks(connection_deleted);
45 void connection::close()
50 do_callbacks(connection_closed);
54 /// get the number of bytes being available as next complete packet
55 connection::packet_size_indicator connection::bytes_available()
57 // no size information -> no packet
58 if (buffer.size() < sizeof(packet_size_indicator))
61 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data())));
63 // enough data for one packet in buffer?
64 if (buffer.size() < sizeof(packet_size_indicator)+psize)
67 // ok, full packet there
71 /** @brief read a complete data packet from the buffer. The packet is removed from the
73 @param[out] data the data package
74 @retval true if packet found
76 bool connection::get_packet(std::string& data)
78 packet_size_indicator psize;
80 if ((psize=bytes_available()))
82 data.assign(buffer,sizeof(packet_size_indicator),psize);
83 buffer.erase(0,sizeof(packet_size_indicator)+psize);
90 /** @brief get (maybe incomplete) data of the next packet from the buffer. Does not remove the data
91 from the connection buffer.
92 @param[out] data the data package
93 @retval full size of the packet when it will be complete
95 unsigned int connection::peek_packet(std::string& data)
97 // no size information -> no packet
98 if (buffer.size() < sizeof(packet_size_indicator))
101 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data())));
103 // not the full data available?
104 packet_size_indicator currsize=psize;
105 if (buffer.size() < currsize+sizeof(packet_size_indicator))
106 currsize=buffer.size()-sizeof(packet_size_indicator);
108 data.assign(buffer,sizeof(packet_size_indicator),currsize);
113 /// remove all data from buffer that is not a complete packet
114 void connection::remove_incomplete_packets()
116 std::string::size_type p=0;
117 std::string::size_type end=buffer.size();
121 // not enough space for size information -> no packet
122 if (p+sizeof(packet_size_indicator) > end)
125 packet_size_indicator psize=ntohl(*((packet_size_indicator*)(buffer.data()+p)));
127 if (p+sizeof(packet_size_indicator)+psize > end)
134 // move p to where the next packet will start
135 p+=sizeof(packet_size_indicator)+psize;
141 // incomplete packets there, remove them
146 /// send a blob to the peer
147 void connection::write(const std::string& data)
149 // prepend packet size to data
150 packet_size_indicator psize=htonl(data.size());
151 std::string send_data(data);
152 send_data.insert(0,(char*)&psize,sizeof(packet_size_indicator));
154 real_write(send_data);
157 /** @brief add a callback
159 @param event event the function will be called at
160 @param func functor (see boost function) that will be called
162 @note use boost::bind to bind to member functions and parameters like this:
163 17 is a fixed parameter that is always added to the call
164 c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));
166 void connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
168 callbacks[event].push_back(func);
171 /** @brief an event has occured, execute the callbacks that are registered for this event
173 @param event event type that has occured
175 void connection::do_callbacks(callback_event_type event)
177 std::list<boost::function<void ()> >::iterator i,ie=callbacks[event].end();
178 for (i=callbacks[event].begin(); i != ie; i++)
182 /** @brief get the callbacks in place for one event
184 @param event event the callbacks should be registered for
185 @return std::list of functors (boost::function) with the callbacks
187 @note if you want to get the callbacks for all events, loop from 0 to __events_end
189 std::list<boost::function<void ()> > connection::get_callback_list(callback_event_type event)
191 return callbacks[event];
194 /** @brief reopen a already closed connection, removes incomplete packets from the buffer
196 @note Only call when the connection is closed.
198 @note Justs cares about the data of connection, reconnecting has to be
199 done in a derived class.
201 void connection::reopen()
204 throw std::logic_error("connection::reopen() called with connection still open");
208 // incomplete buffer data is worthless with a new connection
209 remove_incomplete_packets();
211 do_callbacks(new_connection);