cambio la sintaxis XML de las compuertas

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

diff --git a/Server/include/plaqui/server/documentacion.h b/Server/include/plaqui/server/documentacion.h
index ddf5a026e652554bb9d5370b4b3ea45781bf8bfb..06a78ba289568fcab92bea901ae2e9b0b672e365 100644 (file)
--- a/Server/include/plaqui/server/documentacion.h
+++ b/Server/include/plaqui/server/documentacion.h
@@ -3,7 +3,7 @@
 \section page_server_general Descripción General
        El servidor está dividido en 2 módulos que provean 2 servicios diferentes.
 
 \section page_server_general Descripción General
        El servidor está dividido en 2 módulos que provean 2 servicios diferentes.
 

-       \subsection page_server_general_control Módulo de Control.
+       \subsection page_server_general_control Módulo de Control

                El módulo de control se basa en el protocolo TCP y se encarga de listar
                los archivos de planta disponibles en el servidor, permitiendo cambiar
                las propiedades de cada uno y conocer su estado en términos generales
                El módulo de control se basa en el protocolo TCP y se encarga de listar
                los archivos de planta disponibles en el servidor, permitiendo cambiar
                las propiedades de cada uno y conocer su estado en términos generales


@@ -23,7 +23,7 @@
                Este módulo está implementado por las clases PlaQui::Server::ControlServer
                y PlaQui::Server::ControlClient.
 
                Este módulo está implementado por las clases PlaQui::Server::ControlServer
                y PlaQui::Server::ControlClient.
 

-       \subsection page_server_general_transmision Módulo de Transmisión.
+       \subsection page_server_general_transmision Módulo de Transmisión

                Este módulo se encarga de transmitir la simulación en tiempo real por UDP
                (como si fuera un video). Comienza luego de que el módulo de control recibe
                una petición de transmisión y continúa transmitiendo (en un principio)
                Este módulo se encarga de transmitir la simulación en tiempo real por UDP
                (como si fuera un video). Comienza luego de que el módulo de control recibe
                una petición de transmisión y continúa transmitiendo (en un principio)


@@ -43,7 +43,7 @@
                PlaQui::Server::Receiver.
 
 
                PlaQui::Server::Receiver.
 
 

-\section page_server_protocolo Comandos del Módulo de Control.
+\section page_server_protocolo Comandos del Módulo de Control

        Todos los comandos son rutas de archivos. En un principio no se van a utilizar
        los <em>query string</em> de los datos pasados por GET ni datos adicionales
        recibidos por POST. Es decir, de un <em>request</em> HTTP solo se usara la ruta
        Todos los comandos son rutas de archivos. En un principio no se van a utilizar
        los <em>query string</em> de los datos pasados por GET ni datos adicionales
        recibidos por POST. Es decir, de un <em>request</em> HTTP solo se usara la ruta


@@ -72,14 +72,14 @@
        - <tt>transmission</tt>: Comandos para las transmisiones.
        - <tt>plant</tt>: Comandos para las plantas.
                          
        - <tt>transmission</tt>: Comandos para las transmisiones.
        - <tt>plant</tt>: Comandos para las plantas.
                          

-       \subsection page_server_protocolo_general Comandos para el Servidor.
+       \subsection page_server_protocolo_general Comandos para el Servidor

                Los comandos para el servidor, como se vio previamente, comienzan con
                <tt>/server/</tt> seguido de alguna de las siguientes opciones:
                <table>
                        <tr><th>Comando</th><th>Descripción</th><th>Respuesta</th></tr>
                        <tr>
                Los comandos para el servidor, como se vio previamente, comienzan con
                <tt>/server/</tt> seguido de alguna de las siguientes opciones:
                <table>
                        <tr><th>Comando</th><th>Descripción</th><th>Respuesta</th></tr>
                        <tr>

-                               <td><tt>status</tt></td>
-                               <td>Obtiene estado general del servidor.</td>
+                               <td><tt>info</tt></td>
+                               <td>Obtiene información sobre el servidor.</td>

                                <td>Cantidad de plantas, conexiones, transmisiones, versión,
                                    uptime, etc.</td>
                        </tr>
                                <td>Cantidad de plantas, conexiones, transmisiones, versión,
                                    uptime, etc.</td>
                        </tr>


@@ -90,7 +90,7 @@
                        </tr>
                </table>
 
                        </tr>
                </table>
 

-       \subsection page_server_protocolo_control Comandos para una Conexión de Control.
+       \subsection page_server_protocolo_control Comandos para una Conexión de Control

                Todos los comandos de transmisiones comienzan con <tt>/connection/</tt>
                y continúan con alguna de las siguientes opciones:
                <table>
                Todos los comandos de transmisiones comienzan con <tt>/connection/</tt>
                y continúan con alguna de las siguientes opciones:
                <table>


@@ -107,9 +107,9 @@
                                <td>Nada.</td>
                        </tr>
                </table>
                                <td>Nada.</td>
                        </tr>
                </table>

-               \note Los nombres entre <tt>[</tt> y <tt>]</tt> denotan un argumento.
+               \note Los nombres entre <tt>[</tt> y <tt>]</tt> representan un argumento.

 
 

-       \subsection page_server_protocolo_transmision Comandos para una Transmisión.
+       \subsection page_server_protocolo_transmision Comandos para una Transmisión

                Todos los comandos de transmisiones comienzan con <tt>/transmission/</tt>
                y continúan con alguna de las siguientes opciones:
                <table>
                Todos los comandos de transmisiones comienzan con <tt>/transmission/</tt>
                y continúan con alguna de las siguientes opciones:
                <table>


@@ -121,8 +121,8 @@
                                    etc).</td>
                        </tr>
                        <tr>
                                    etc).</td>
                        </tr>
                        <tr>

-                               <td><tt>start/[plant]/[host]/[port]</tt></td>
-                               <td>Comienza la transmisión de la planta [plant] al [host]
+                               <td><tt>start/[pl]/[host]/[port]</tt></td>
+                               <td>Comienza la transmisión de la planta [pl] al [host]

                                    en el puerto [port].</td>
                                <td>Nada.</td>
                        </tr>
                                    en el puerto [port].</td>
                                <td>Nada.</td>
                        </tr>


@@ -133,9 +133,9 @@
                                <td>Nada.</td>
                        </tr>
                </table>
                                <td>Nada.</td>
                        </tr>
                </table>

-               \note Los nombres entre <tt>[</tt> y <tt>]</tt> denotan un argumento.
+               \note Los nombres entre <tt>[</tt> y <tt>]</tt> representan un argumento.

 
 

-       \subsection page_server_protocolo_planta Comandos para una Planta.
+       \subsection page_server_protocolo_planta Comandos para una Planta

                Todos los comandos de plantas comienzan con <tt>/plant/</tt> y continúan con
                alguna de las siguientes opciones:
                <table>
                Todos los comandos de plantas comienzan con <tt>/plant/</tt> y continúan con
                alguna de las siguientes opciones:
                <table>


@@ -147,34 +147,92 @@
                                    corriendo o no, uptime, cantidad de elementos,etc).</td>
                        </tr>
                        <tr>
                                    corriendo o no, uptime, cantidad de elementos,etc).</td>
                        </tr>
                        <tr>

-                               <td><tt>get/[planta]</tt></td>
-                               <td>Obtiene la planta de nombre [planta].</td>
+                               <td><tt>get/[pl]</tt></td>
+                               <td>Obtiene la planta de nombre [pl].</td>

                                <td>El mismo archivo que se crea en el Constructor.</td>
                        </tr>
                        <tr>
                                <td>El mismo archivo que se crea en el Constructor.</td>
                        </tr>
                        <tr>

-                               <td><tt>stop/[planta]</tt></td>
-                               <td>Finaliza la simulación de la planta de nombre <planta>.</td>
+                               <td><tt>set/[pl]/[el]/[pr]/[val]</tt></td>
+                               <td>Cambia la propiedad [pr] del elemento [el], asignándole
+                                   el valor [val] a planta de nombre [pl].</td>

                                <td>Nada.</td>
                        </tr>
                        <tr>
                                <td>Nada.</td>
                        </tr>
                        <tr>

-                               <td><tt>set/[planta]/[elem]/[prop]/[val]</tt></td>
-                               <td>Cambia la propiedad [prop] del elemento [elem], asignándole
-                                   el valor [val] a planta de nombre [planta].</td>
+                               <td><tt>set_frequency/[pl]/[hz]</tt></td>
+                               <td>Cambia la frecuencia de refresco de la simulación de la
+                                   planta de nombre [pl] a [hz] veces por segundo. Si [hz]
+                                   es cero ("0"), se usa la frecuencia de refresco por
+                                   omisión del servidor.</td>
+                               <td>Nada.</td>
+                       </tr>
+                       <tr>
+                               <td><tt>start/[pl]</tt></td>
+                               <td>Reanuda (o comienza) la simulación de la planta de nombre
+                                   [pl].</td>
+                               <td>Nada.</td>
+                       </tr>
+                       <tr>
+                               <td><tt>stop/[pl]</tt></td>
+                               <td>Pausa la simulación de la planta de nombre
+                                   [pl].</td>
+                               <td>Nada.</td>
+                       </tr>
+                       <tr>
+                               <td><tt>remove/[pl]</tt></td>
+                               <td>Finaliza la simulación de la planta de nombre
+                                   [pl] eliminandola del servidor.</td>

                                <td>Nada.</td>
                        </tr>
                </table>
                                <td>Nada.</td>
                        </tr>
                </table>

-               \note Los nombres entre <tt>[</tt> y <tt>]</tt> denotan un argumento.
+               \note Los nombres entre <tt>[</tt> y <tt>]</tt> representan un argumento.
+
+\section page_server_uso Modo de uso
+       \subsection page_server_uso_inicio Inicio del servidor
+               Para iniciar el servidor es necesario disponer de un archivo XML de
+               planta (por ejemplo, generado por el Constructor).

 
 

-\section page_server_uso Modo de uso.
-       Para utilizar el servidor es necesario disponer de un archivo XML de planta
-       (por ejemplo, generado por el Constructor).
+               Invocación del servidor:
+               \verbatim ./plaqui-server [archivo] [puerto] \endverbatim

 
 

-       Invocación del servidor:
-       \verbatim ./plaqui-server [planta.xml] [puerto] \endverbatim
+               Ambos argumentos son opcionales. El primero, <tt>[archivo]</tt>, es la
+               ubicación del archivo con la descripción de la planta a simular (por omisión
+               <tt>planta.xml</tt>). El segundo, <tt>[puerto]</tt>, es el puerto en el cual
+               se van a atender las peticiones al servidor (por omisión 7522).

 
 

-       Ambos argumentos son opcionales. El primero, <tt>[planta.xml]</tt>, es la
-       ubicación del archivo con la descripción de la planta a simular (por omisión
-       <tt>prueba.xml</tt>). El segundo, <tt>[puerto]</tt>, es el puerto en el cual
-       se van a atender las peticiones al servidor (por omisión 7522).
+       \subsection page_server_uso_estado Estado del servidor
+               Mientras el servidor se ejecuta, va imprimiendo en la salida estándar su
+               estado. Se imprime cada vez que llega una conexión entrante y cada vez que
+               se detecta un error.
+
+               Otro tipo de información del estado del servidor puede ser obtenida desde
+               el cliente a través del comando <tt>/server/info</tt> (ver
+               \ref page_server_protocolo_general).
+
+               \note Los errores se imprimen en la salida de error, no en la salida
+                     estándar.
+
+       \subsection page_server_uso_fin Finalización del servidor
+               Hay varias formas de finalizar el servidor:
+               - Enviando una señal de interrupción (<tt>SIGINT</tt>), por ejemplo,
+                 presionando la combinación de teclas <tt>CTRL-C</tt>.
+               - Enviando una señal de salida (<tt>SIGQUIT</tt>) o de terminación
+                 (<tt>SIGTERM</tt>), por ejemplo, a través del comando
+                 <tt>kill(1)</tt>.
+               - Enviando un comando <tt>/server/stop</tt> desde un cliente (ver
+                 \ref page_server_protocolo_general).
+
+               Cualquiera de estos métodos es válido y finaliza el servidor de forma
+               correcta.
+
+*/
+
+/** \namespace PlaQui::Server
+
+Infrastructura cliente-servidor para PlaQui.
+
+Bajo este espacio de nombres (namespace) se encuentran todas las clases para la
+comunicación cliente-servidor de PlaQui. Esto no incluye la interfaz gráfica del
+cliente.

 
 */
 
 */

+