libt2n: (gerd) doxygenize

[libt2n] / src / socket_client.hxx

diff --git a/src/socket_client.hxx b/src/socket_client.hxx
index a17ec88..8a379f8 100644 (file)
--- a/src/socket_client.hxx
+++ b/src/socket_client.hxx
@@ -24,7 +24,10 @@
 
 namespace libt2n
 {
+/** @brief a connection from client to server using sockets.
 
+    Use this class to connect from a client to a server.
+ */
 class socket_client_connection : public client_connection, public socket_handler
 {
     static const int max_retries_default=3;
@@ -45,6 +48,13 @@ class socket_client_connection : public client_connection, public socket_handler
         socket_client_connection(const std::string& _server, int _port, int _max_retries=max_retries_default);
         socket_client_connection(const std::string& _path, int _max_retries=max_retries_default);
 
+        /** @brief read data from the socket and copy it into 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)
+        */
         bool fill_buffer(long long usec_timeout=-1)
             { return socket_handler::fill_buffer(buffer,usec_timeout); }