X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=src%2Fconnection.hxx;h=4092fde3ee8b79b486c1b70d6ecbdf8cb1d4400f;hp=9142c522e68ef522781077cc6976a1c5cf79b03f;hb=d535333ffe637c9e547e68b792f334c229641520;hpb=a11e19b7adab2d5b937573701959562f06087ac5

diff --git a/src/connection.hxx b/src/connection.hxx
index 9142c52..4092fde 100644
--- a/src/connection.hxx
+++ b/src/connection.hxx
@@ -21,9 +21,14 @@
 
 #include <string>
 
+#include "types.hxx"
+
+
 namespace libt2n
 {
 
+/** @brief a connection between client and server. abstact.
+*/
 class connection
 {
     private:
@@ -31,7 +36,7 @@ class connection
 
     protected:
         connection()
-        { closed=false; }
+            { closed=false; }
 
         std::string buffer;
 
@@ -41,18 +46,31 @@ class connection
 
         virtual void real_write(const std::string& data)=0;
 
+        virtual std::ostream* get_logstream(log_level_values level)=0;
+
     public:
-        ~connection()
+        virtual ~connection()
             { close(); }
 
+        /// is this connection closed or not
         bool is_closed()
             { return closed; }
 
+        /// close this connection
         virtual void close()
             { closed=true; }
 
-        virtual void fill_buffer(long long usec_timeout=-1)=0;
+        /** @brief look for new data and store it in the local buffer
+            @param usec_timeout wait until new data is found, max timeout usecs.
+                  -1: wait endless
+                   NULL: no timeout
+            @retval true if new data was found (does not mean that the received data 
+                    is a complete packet though)
+        */
+        virtual bool fill_buffer(long long usec_timeout=-1)=0;
         bool get_packet(std::string& data);
+
+        /// returns true if a complete data packet is in the buffer. retrieve it with get_packet().
         bool packet_available()
             { return bytes_available(); }