libt2n: (gerd) basic command handling (still some todos)

[libt2n] / src / connection.hxx

diff --git a/src/connection.hxx b/src/connection.hxx
index 94506e2..633798b 100644 (file)
--- a/src/connection.hxx
+++ b/src/connection.hxx
@@ -24,6 +24,8 @@
 namespace libt2n
 {
 
+/** @brief a connection between client and server. abstact.
+*/
 class connection
 {
     private:
@@ -45,14 +47,25 @@ class connection
         virtual ~connection()
             { close(); }
 
+        /// is this connection closed or not
         bool is_closed()
             { return closed; }
 
+        /// close this connection
         virtual void close()
             { closed=true; }
 
+        /** @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(); }