Se agrega un poco mas de documentacion como para cerrar el manual de desarrollo.

[z.facultad/75.42/plaqui.git] / Server / include / plaqui / server / tcpserver.h

diff --git a/Server/include/plaqui/server/tcpserver.h b/Server/include/plaqui/server/tcpserver.h
index 5277f2bf188d2b9fb4c867495c518bfcf7c743ab..368594e6b41e394cd2f521a61d65761954410da8 100644 (file)
--- a/Server/include/plaqui/server/tcpserver.h
+++ b/Server/include/plaqui/server/tcpserver.h
@@ -40,8 +40,25 @@ namespace PlaQui {
 namespace Server {
 
        /**
-        * Servidor de plantas químicas.
-        * Maneja muchas conexiones, de control o de transmisión.
+        * Servidor genéríco TCP/IP.
+        *
+        * Maneja muchas conexiones, en threads. En términos generales todo lo que
+        * hace es algo parecido a esto:
+        * \code
+        * while (!stop) {
+        *     Connection* conexion = new_connection(accept());
+        *     connections.push_back(conexion);
+        * }
+        * \endcode
+        *
+        * new_connection() es un método virtual puro que hay que definir en las
+        * subclases para hacer un servidor específico que trabaje con un protocolo
+        * determinado. new_connection() devuelve un puntero a una
+        * \ref Connection "conexión".
+        *
+        * on_connection_finished() maneja la
+        * \ref Runnable::signal_finished "señal para indicar que una conexión terminó"
+        * para eliminarla de la \ref connections "lista de conexiones".
         */
        class TCPServer: public Runnable {