libt2n: (gerd) doxygenize

[libt2n] / src / socket_server.hxx

diff --git a/src/socket_server.hxx b/src/socket_server.hxx
index 5dcf4f3..a72ae48 100644 (file)
--- a/src/socket_server.hxx
+++ b/src/socket_server.hxx
@@ -29,17 +29,28 @@
 namespace libt2n
 {
 
-/**
-    Socket based server class
+class socket_server_connection;
+
+/** @brief Socket based server class
+
+    Use this class to instantiate a server listening for client connections.
+    Call fill_buffer() to read data from the network and get_packet() to retrieve
+    this data. Don't forget to call cleanup() from time to time to remove closed
+    connections and close idle ones.
 */
 class socket_server : public socket_handler, public server
 {
+    friend class socket_server_connection;
+
     private:
         fd_set connection_set;
         std::string unix_path;
 
         void new_connection();
 
+        bool fill_connection_buffers();
+        void remove_connection_socket(int sock);
+
     protected:
         void log(log_level_values level, const std::string& message)
             { log(level,message.c_str()); }
@@ -52,14 +63,12 @@ class socket_server : public socket_handler, public server
 
         ~socket_server();
 
-        void fill_buffer(long long usec_timeout=-1);
-        void fill_connection_buffers();
-
-        void remove_connection_socket(int sock);
+        bool fill_buffer(long long usec_timeout=-1);
 };
 
-/**
-    Socket based connection class
+/** @brief Socket based connection
+
+    This class is used within a socket_server to represent the connection to each client.
 */
 class socket_server_connection : public socket_handler, public server_connection
 {