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/archive/binary_oarchive.hpp>
24 #include <boost/archive/binary_iarchive.hpp>
25 #include <boost/archive/xml_oarchive.hpp>
26 #include <boost/archive/xml_iarchive.hpp>
27 #include <boost/serialization/serialization.hpp>
29 #include <boost/bind.hpp>
31 #include "command_client.hxx"
44 * @param _c connection for this command. Ownership of the pointer is outside.
45 * @param _command_timeout_usec timeout until the command has to be completed
46 * @param _hello_timeout_usec timeout until hello has to be received
48 command_client::command_client(client_connection* _c, long long _command_timeout_usec, long long _hello_timeout_usec)
50 , constructorException(NULL)
52 command_timeout_usec=_command_timeout_usec;
53 hello_timeout_usec=_hello_timeout_usec;
56 c->add_callback(new_connection,bind(&command_client::read_hello, boost::ref(*this)));
58 // don't expect hello from an always closed connection (like dummy_client_connection)
59 if (!is_connection_closed())
65 catch (t2n_communication_error &e)
69 // store a copy of the exception that you can find out details about the error later
70 constructorException = e.clone();
82 command_client::~command_client()
84 if (constructorException)
86 delete constructorException;
87 constructorException = NULL;
91 /** @brief replace the connection currently in use with a new one
92 @param _c pointer to the new connection
94 @note the old connection must still be valid when this method is called,
95 it can safely be deleted after this method returned
97 @note all callbacks registered on the old connection will be copied over
100 void command_client::replace_connection(client_connection* _c)
102 // copy all callbacks registered on the old connection
103 for(callback_event_type e=static_cast<callback_event_type>(0);
105 e=static_cast<callback_event_type>(static_cast<int>(e)+1))
107 list<boost::function<void ()> > evcb=c->get_callback_list(e);
109 for (list<boost::function<void ()> >::iterator i=evcb.begin(); i != evcb.end(); i++)
110 _c->add_callback(e,*i);
113 // replace the connection
119 /** @brief return a complete packet
120 @param usec_timeout maximum microseconds to wait until the packet is complete
121 @retval packet data as std::string
123 @note throws a t2n_transfer_error if the timeout is exceeded
125 std::string command_client::read_packet(const long long &usec_timeout)
128 bool got_packet=false;
129 long long my_timeout=usec_timeout;
130 while(!(got_packet=c->get_packet(resultpacket)) && my_timeout > 0 && !c->is_closed())
131 c->fill_buffer(my_timeout,&my_timeout);
134 throw t2n_transfer_error("timeout exceeded");
139 /** @brief read and check the hello message at the beginning of a connection
141 @note throws exceptions if something went wrong
143 void command_client::read_hello()
146 bool got_packet=false;
147 long long my_timeout=hello_timeout_usec;
148 while(!(got_packet=c->get_packet(resultpacket)) && my_timeout > 0 && !c->is_closed())
150 c->fill_buffer(my_timeout,&my_timeout);
152 c->peek_packet(resultpacket);
153 check_hello(resultpacket); // will throw before timeout if wrong data received
157 throw t2n_transfer_error("timeout exceeded");
159 if (!check_hello(resultpacket))
160 throw t2n_version_mismatch("illegal hello received (incomplete): "+resultpacket);
163 /** @brief check if a hello message is valid
164 @param hellostr std::string with the message to check
165 @retval true if the hello is good and complete
167 @note you can check incomplete hellos. you will get a false return value
168 but no exception. throws exceptions as soon as something is wrong.
170 bool command_client::check_hello(const std::string& hellostr)
172 istringstream hello(hellostr);
176 if (hello.read(&chk,1))
179 throw t2n_version_mismatch("illegal hello received (T2N)");
184 if (hello.read(&chk,1))
187 throw t2n_version_mismatch("illegal hello received (T2N)");
192 if (hello.read(&chk,1))
195 throw t2n_version_mismatch("illegal hello received (T2N)");
200 if (hello.read(&chk,1))
203 throw t2n_version_mismatch("illegal hello received (T2N)");
209 if (hello >> prot_version)
211 if (prot_version != PROTOCOL_VERSION)
212 throw t2n_version_mismatch("not compatible with the server protocol version");
217 if (hello.read(&chk,1))
220 throw t2n_version_mismatch("illegal hello received (1. ;)");
226 if (hello.read((char*)&hbo,sizeof(hbo)))
229 throw t2n_version_mismatch("host byte order not matching");
234 if (hello.read(&chk,1))
237 throw t2n_version_mismatch("illegal hello received (2. ;)");
245 /** @brief send a command to the server and store the result
246 @param cmd pointer to a command-object
247 @param[out] res result container to store the result in
249 @note you can check incomplete hellos. you will get a false return value
250 but no exception. throws exceptions as soon as something is wrong.
252 void command_client::send_command(command* cmd, result_container &res)
255 command_container cc(cmd);
256 boost::archive::binary_oarchive oa(ofs);
258 if (is_connection_closed())
259 throw t2n_transfer_error("connection to server is closed");
265 catch(boost::archive::archive_exception &e)
268 msg << "archive_exception while serializing on client-side, code " << e.code << " (" << e.what() << ")";
269 throw t2n_serialization_error(msg.str());
275 if ((ostr=c->get_logstream(fulldebug))!=NULL)
277 (*ostr) << "sending command, decoded data: " << std::endl;
278 boost::archive::xml_oarchive xo(*ostr);
279 xo << BOOST_SERIALIZATION_NVP(cc);
284 istringstream ifs(read_packet(command_timeout_usec));
285 boost::archive::binary_iarchive ia(ifs);
291 catch(boost::archive::archive_exception &e)
294 msg << "archive_exception while deserializing on client-side, code " << e.code << " (" << e.what() << ")";
295 throw t2n_serialization_error(msg.str());
300 if ((ostr=c->get_logstream(fulldebug))!=NULL)
302 (*ostr) << "received result, decoded data: " << std::endl;
303 boost::archive::xml_oarchive xo(*ostr);
304 xo << BOOST_SERIALIZATION_NVP(res);