libt2n: (tomj) documented code problems; have to find out if this is the source of...

[libt2n] / src / socket_wrapper.hxx

diff --git a/src/socket_wrapper.hxx b/src/socket_wrapper.hxx
index ebb85f6..093a809 100644 (file)
--- a/src/socket_wrapper.hxx
+++ b/src/socket_wrapper.hxx
@@ -32,6 +32,12 @@
 namespace libt2n
 {
 
+/** @brief a basic implementation of ConnectionWrapper
+
+    This is a basic version of a ConnectionWrapper which does not do any fancy
+    error handling or anything, it justs executes the regular calls. Use this
+    wrapper if you only want to use the singleton-feature of T2nSingletonWrapper.
+*/
 class BasicSocketWrapper : public ConnectionWrapper
 {
     protected:
@@ -46,6 +52,9 @@ class BasicSocketWrapper : public ConnectionWrapper
 
         std::auto_ptr<socket_client_connection> c;
 
+        // TODO: Mark object as non-copyable as it contains an auto_ptr.
+        //       This will make sure nobody every tries to put this in a STL container
+
     public:
         BasicSocketWrapper(int _port, const std::string& _server="127.0.0.1", 
             long long _connect_timeout_usec=socket_client_connection::connect_timeout_usec_default, 
@@ -69,6 +78,11 @@ class BasicSocketWrapper : public ConnectionWrapper
         void set_logging(std::ostream *_logstream, log_level_values _log_level);
 };
 
+/** @brief a wrapper implementing reconnect-then-throw
+
+    This ConnectionWrapper tries to reconnect to the server if something with the connection
+    goes wrong. If even reconnecting max_retries times does not help, an exception is thrown.
+*/
 class ReconnectSocketWrapper : public BasicSocketWrapper
 {
     public:
@@ -87,6 +101,7 @@ class ReconnectSocketWrapper : public BasicSocketWrapper
         bool handle(command_client* stubBase, boost::function< void() > f);
 };
 
+/// a placeholder-client_connection which is closed all the time
 class dummy_client_connection : public client_connection
 {
     private:
@@ -102,6 +117,12 @@ class dummy_client_connection : public client_connection
             { return false; }
 };
 
+/** @brief a wrapper implementing reconnect-then-ignore
+
+    This ConnectionWrapper tries to reconnect to the server if something with the connection
+    goes wrong. If even reconnecting max_retries times does not help, the complete t2n-call is
+    ignored. The return value of the call will be created with the default constructor.
+*/
 class ReconnectIgnoreFailureSocketWrapper : public ReconnectSocketWrapper
 {
     private: