libt2n: (gerd) more documentation-polishing

[libt2n] / src / socket_wrapper.hxx

diff --git a/src/socket_wrapper.hxx b/src/socket_wrapper.hxx
index 51c0693..067931e 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:
@@ -62,8 +68,18 @@ class BasicSocketWrapper : public ConnectionWrapper
             { }
 
         client_connection* get_connection(void);
+
+        bool connection_established(void)
+            { return (c.get() != NULL); }
+
+        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:
@@ -79,12 +95,36 @@ class ReconnectSocketWrapper : public BasicSocketWrapper
             : BasicSocketWrapper(_path,_connect_timeout_usec,_max_retries)
             { }
 
-        void handle(command_client* stubBase, boost::function< void() > f);
+        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:
+        void real_write(const std::string& data)
+            { }
+
+    public:
+        dummy_client_connection()
+            : client_connection()
+            { close(); }
+
+        bool fill_buffer(long long usec_timeout=-1, long long *usec_timeout_remaining=NULL)
+            { 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:
+        dummy_client_connection dc;
+
     public:
         ReconnectIgnoreFailureSocketWrapper(int _port, const std::string& _server="127.0.0.1", 
             long long _connect_timeout_usec=socket_client_connection::connect_timeout_usec_default, 
@@ -99,11 +139,9 @@ class ReconnectIgnoreFailureSocketWrapper : public ReconnectSocketWrapper
             { }
 
         client_connection* get_connection(void);
-        void handle(command_client* stubBase, boost::function< void() > f);
+        bool handle(command_client* stubBase, boost::function< void() > f);
 };
 
-
-
 }
 
 #endif