libt2n: (tomj) don't use std::auto_ptr in command_client, the pointer will get lost...

[libt2n] / src / command_client.cpp

diff --git a/src/command_client.cpp b/src/command_client.cpp
index 63ff539..5d71692 100644 (file)
--- a/src/command_client.cpp
+++ b/src/command_client.cpp
@@ -39,8 +39,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;
@@ -60,8 +67,7 @@ command_client::command_client(client_connection* _c, long long _command_timeout
             c->close();
 
             // store a copy of the exception that you can find out details about the error later
-            std::auto_ptr<t2n_exception> tmp(e.clone());
-            constructorException=tmp;
+            constructorException = e.clone();
         }
         catch (...)
         {
@@ -70,8 +76,19 @@ command_client::command_client(client_connection* _c, long long _command_timeout
     }
 }
 
-/** @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,
@@ -99,6 +116,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;
@@ -113,6 +136,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;
@@ -133,7 +160,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);
 
@@ -208,6 +242,13 @@ 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;
@@ -236,7 +277,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());