X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=src%2Fcommand_client.cpp;h=9945a5aecfc8f73345c309c5350650a4e5eb4ea8;hp=8ccbf1046d3e97c7cfbf0d0b983dc0c57ac8b2fa;hb=19facd8558fe2e32ce843860b40631ebe03ff3cf;hpb=fb3345ada7ea94225b78994fd50e3de693a2a3d5 diff --git a/src/command_client.cpp b/src/command_client.cpp index 8ccbf10..9945a5a 100644 --- a/src/command_client.cpp +++ b/src/command_client.cpp @@ -1,21 +1,24 @@ -/*************************************************************************** - * Copyright (C) 2006 by Gerd v. Egidy * - * gve@intra2net.com * - * * - * This library is free software; you can redistribute it and/or modify * - * it under the terms of the GNU Lesser General Public License version * - * 2.1 as published by the Free Software Foundation. * - * * - * This library is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU Lesser General Public License for more details. * - * * - * You should have received a copy of the GNU Lesser General Public * - * License along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - ***************************************************************************/ +/* +Copyright (C) 2006 by Intra2net AG - Gerd v. Egidy + +The software in this package is distributed under the GNU General +Public License version 2 (with a special exception described below). + +A copy of GNU General Public License (GPL) is included in this distribution, +in the file COPYING.GPL. + +As a special exception, if other files instantiate templates or use macros +or inline functions from this file, or you compile this file and link it +with other works to produce a work based on this file, this file +does not by itself cause the resulting work to be covered +by the GNU General Public License. + +However the source code for this file must still be made available +in accordance with section (3) of the GNU General Public License. + +This exception does not invalidate any other reasons why a work based +on this file might be covered by the GNU General Public License. +*/ #include #include @@ -39,8 +42,15 @@ using namespace std; namespace libt2n { +/** + * Constructor + * @param _c connection for this command. Ownership of the pointer is outside. + * @param _command_timeout_usec timeout until the command has to be completed + * @param _hello_timeout_usec timeout until hello has to be received + */ command_client::command_client(client_connection* _c, long long _command_timeout_usec, long long _hello_timeout_usec) : c(_c) + , constructorException(NULL) { command_timeout_usec=_command_timeout_usec; hello_timeout_usec=_hello_timeout_usec; @@ -49,12 +59,39 @@ command_client::command_client(client_connection* _c, long long _command_timeout c->add_callback(new_connection,bind(&command_client::read_hello, boost::ref(*this))); // don't expect hello from an always closed connection (like dummy_client_connection) - if (!c->is_closed()) - read_hello(); + if (!is_connection_closed()) + { + try + { + read_hello(); + } + catch (t2n_communication_error &e) + { + c->close(); + + // store a copy of the exception that you can find out details about the error later + constructorException = e.clone(); + } + catch (...) + { + throw; + } + } } -/** @brief replace the connection currently in use with a new one +/** + * Destructor + */ +command_client::~command_client() +{ + if (constructorException) + { + delete constructorException; + constructorException = NULL; + } +} +/** @brief replace the connection currently in use with a new one @param _c pointer to the new connection @note the old connection must still be valid when this method is called, @@ -82,6 +119,12 @@ void command_client::replace_connection(client_connection* _c) read_hello(); } +/** @brief return a complete packet + @param usec_timeout maximum microseconds to wait until the packet is complete + @retval packet data as std::string + + @note throws a t2n_transfer_error if the timeout is exceeded +*/ std::string command_client::read_packet(const long long &usec_timeout) { string resultpacket; @@ -96,6 +139,10 @@ std::string command_client::read_packet(const long long &usec_timeout) return resultpacket; } +/** @brief read and check the hello message at the beginning of a connection + + @note throws exceptions if something went wrong +*/ void command_client::read_hello() { string resultpacket; @@ -116,7 +163,14 @@ void command_client::read_hello() throw t2n_version_mismatch("illegal hello received (incomplete): "+resultpacket); } -bool command_client::check_hello(const string& hellostr) +/** @brief check if a hello message is valid + @param hellostr std::string with the message to check + @retval true if the hello is good and complete + + @note you can check incomplete hellos. you will get a false return value + but no exception. throws exceptions as soon as something is wrong. +*/ +bool command_client::check_hello(const std::string& hellostr) { istringstream hello(hellostr); @@ -191,12 +245,22 @@ bool command_client::check_hello(const string& hellostr) return true; } +/** @brief send a command to the server and store the result + @param cmd pointer to a command-object + @param[out] res result container to store the result in + + @note you can check incomplete hellos. you will get a false return value + but no exception. throws exceptions as soon as something is wrong. +*/ void command_client::send_command(command* cmd, result_container &res) { ostringstream ofs; command_container cc(cmd); boost::archive::binary_oarchive oa(ofs); + if (is_connection_closed()) + throw t2n_transfer_error("connection to server is closed"); + try { oa << cc; @@ -216,7 +280,7 @@ void command_client::send_command(command* cmd, result_container &res) (*ostr) << "sending command, decoded data: " << std::endl; boost::archive::xml_oarchive xo(*ostr); xo << BOOST_SERIALIZATION_NVP(cc); - } + } c->write(ofs.str());