X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/9317ed8f3f8241a30fd09b6800ff96b2ac138747..b81da7a08ef57c3d0b9baa229eb5bd6b701fd84a:/Server/include/plaqui/server/documentacion.h
diff --git a/Server/include/plaqui/server/documentacion.h b/Server/include/plaqui/server/documentacion.h
index 2d022e4..2b268ec 100644
--- a/Server/include/plaqui/server/documentacion.h
+++ b/Server/include/plaqui/server/documentacion.h
@@ -1,6 +1,6 @@
/** \page page_server PlaQui Server
-\section page_server_general Descripción General
+\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.
@@ -23,6 +23,21 @@
Este módulo está implementado por las clases PlaQui::Server::ControlServer
y PlaQui::Server::ControlClient.
+ \subsubsection page_server_general_control_http Ventajas del protocolo HTTP.
+ Las ventajas de montar el protocolo del servidor sobre el protocolo
+ HTTP son muchas. Las más destacables son las más obvias.
+
+ Al usar el protocolo HTTP se puede controlar el servidor con
+ cualquier navegador web. Al ser las respuestas archivos XML es
+ fácil agregar hojas de estilo XSLT para convertirlas en HTML y
+ transformar un navegador web con capacidad de procesar hojas XSLT
+ (como Mozilla) en un cliente casi con las mismas capacidades y
+ facilidad de uso que uno hecho especialmente para PlaQui.
+
+ Otra ventaja importante es que muchos lugares sin acceso real a
+ Internet tienen acceso a un proxy HTTP, por lo que la accesibilidad
+ del servicio se vuelve muy fácil incluso en redes muy protegidas.
+
\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
@@ -78,8 +93,8 @@
| Comando | Descripción | Respuesta |
|---|
- | status |
- Obtiene estado general del servidor. |
+ info |
+ Obtiene información sobre el servidor. |
Cantidad de plantas, conexiones, transmisiones, versión,
uptime, etc. |
@@ -107,7 +122,7 @@
Nada. |
- \note Los nombres entre [ y ] denotan un argumento.
+ \note Los nombres entre [ y ] representan un argumento.
\subsection page_server_protocolo_transmision Comandos para una Transmisión.
Todos los comandos de transmisiones comienzan con /transmission/
@@ -121,8 +136,8 @@
etc).
- | start/[plant]/[host]/[port] |
- Comienza la transmisión de la planta [plant] al [host]
+ | start/[pl]/[host]/[port] |
+ Comienza la transmisión de la planta [pl] al [host]
en el puerto [port]. |
Nada. |
@@ -133,7 +148,7 @@
Nada. |
- \note Los nombres entre [ y ] denotan un argumento.
+ \note Los nombres entre [ y ] representan un argumento.
\subsection page_server_protocolo_planta Comandos para una Planta.
Todos los comandos de plantas comienzan con /plant/ y continúan con
@@ -147,55 +162,106 @@
corriendo o no, uptime, cantidad de elementos,etc).
- | get/[planta] |
- Obtiene la planta de nombre [planta]. |
+ get/[pl] |
+ Obtiene la planta de nombre [pl]. |
El mismo archivo que se crea en el Constructor. |
- | set/[planta]/[elem]/[prop]/[val] |
- Cambia la propiedad [prop] del elemento [elem], asignándole
- el valor [val] a planta de nombre [planta]. |
+ set/[pl]/[el]/[pr]/[val] |
+ Cambia la propiedad [pr] del elemento [el], asignándole
+ el valor [val] a planta de nombre [pl]. |
Nada. |
- | set_frequency/[planta]/[vecesxseg] |
+ set_frequency/[pl]/[hz] |
Cambia la frecuencia de refresco de la simulación de la
- planta de nombre [planta] a [vecesxseg] veces por
- segundo. Si [vecesxseg] es cero ("0"), se usa la frecuencia
- de refresco por omisión del servidor. |
+ 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.
Nada. |
- | start/[planta] |
+ start/[pl] |
Reanuda (o comienza) la simulación de la planta de nombre
- [planta]. |
+ [pl].
Nada. |
- | stop/[planta] |
+ stop/[pl] |
Pausa la simulación de la planta de nombre
- [planta]. |
+ [pl].
Nada. |
- | remove/[planta] |
+ remove/[pl] |
Finaliza la simulación de la planta de nombre
- [planta] eliminandola del servidor. |
+ [pl] eliminandola del servidor.
Nada. |
- \note Los nombres entre [ y ] denotan un argumento.
+ \note Los nombres entre [ y ] representan un argumento.
+
+\section page_server_respuesta Respuestas del Módulo de Control.
+ Las respuestas del servidor, como se dijo anteriormente, son respuestas HTTP, cuyo
+ cuerpo es un archivo XML. Este archivo se compone de un tag XML
+ plaqui-response y tiene como atributos obligatorios code (indica
+ el código de respuesta, para saber si se realizó bien el comando) y version
+ (indica la versión del formato del archivo XML, para preveer la posibilidad de que
+ cambie en futuras versiones). También tiene un atributo opcional description
+ que permite agregar una descripción sobre la respuesta, útil para observar respuestas
+ con un navegador u otro cliente no específico. El tagplaqui-response
+ puede tener un contenido, en caso de que la respuesta necesite enviar información al
+ cliente (como al obtener una planta o una lista). El contenido es a su vez XML y en
+ el caso de la obtención de una planta tiene el mismo formato que el utilizado 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).
+ \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).
+
+ Invocación del servidor:
+ \verbatim ./plaqui-server [archivo] [puerto] \endverbatim
+
+ Ambos argumentos son opcionales. El primero, [archivo], es la
+ ubicación del archivo con la descripción de la planta a simular (por omisión
+ planta.xml). El segundo, [puerto], 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 /server/info (ver
+ \ref page_server_protocolo_general).
- Invocación del servidor:
- \verbatim ./plaqui-server [planta.xml] [puerto] \endverbatim
+ \note Los errores se imprimen en la salida de error, no en la salida
+ estándar.
- Ambos argumentos son opcionales. El primero, [planta.xml], es la
- ubicación del archivo con la descripción de la planta a simular (por omisión
- prueba.xml). El segundo, [puerto], es el puerto en el cual
- se van a atender las peticiones al servidor (por omisión 7522).
+ \subsection page_server_uso_fin Finalización del servidor.
+ Hay varias formas de finalizar el servidor:
+ - Enviando una señal de interrupción (SIGINT), por ejemplo,
+ presionando la combinación de teclas CTRL-C.
+ - Enviando una señal de salida (SIGQUIT) o de terminación
+ (SIGTERM), por ejemplo, a través del comando
+ kill(1).
+ - Enviando un comando /server/stop 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.
+
+*/
+