Changes between Version 3 and Version 4 of Version2/Desarrollo/Communications

Timestamp:

Mar 21, 2011, 9:26:54 AM (13 years ago)

Author:

edulix

Comment:

--

Version2/Desarrollo/Communications

@@ -35 +35 @@
 Los mensajes que se intercambian en este protocolo son los siguientes:
 
-== Request ==
+== Job Execution Request ==
 
-Es el mensaje que envía la consola web al servicio job request de un cliente cuando desde la consola web se solicita la realización de una tarea. La petición debe ir a la url {{{/jobrequest/(?P<id>[0-9]+)}}} del servicio job executer. El id se utilizará para luego poder referenciar este trabajo, y el contenido de los mensajes tiene formato JSON, con los siguientes campos:
+Es el mensaje que envía la consola web al servicio job  executer de un cliente cuando desde la consola web se solicita la realización de una tarea. La petición debe ir a la url {{{/jobrequest/(?P<id>[0-9]+)}}} del servicio job executer. El id se utilizará para luego poder referenciar este trabajo, y el contenido de los mensajes tiene formato JSON, con los siguientes campos:
 
 {{{
@@ -64 +64 @@
  * El campo ''sequential'' es opcional e indica si el comando se debe ejecutar inmediatamente (''False''), o debe encolarse de tal manera que se ejecute en la cola de comandos importantes que se deben ejecutar uno detrás de otro (''True''). Por defecto los comandos se ejecutan inmediatamente sin ser encolados.
  * El campo ''files'' es opcional y contiene una lista de cadenas que contienen datos que deben meterse en un fichero temporal y pueden ser referenciados mediante la lista de argumentos ''args''. Así, el primer fichero puede ser referenciado en ''args'' utilizando un argumento con valor '$0', el segundo fichero con '$1', y así sucesivamente.
+
+== Job Update ==
+
+Un mensaje de tipo ''Job Update'' es enviado desde el servicio job executer de un cliente al servicio job receiver de un servidor opengnsys. El objetivo de este mensaje es mandar información actualizada referente a la ejecución de un comando desde el cliente al servidor.
+
+La petición debe ir a la url {{{/updatejob/normal/(?P<id>\d+)/(?P<status>[A-Z]+)}}}. El id es único y se refiere al id del trabajo (Job) que fue recibido por el cliente en un mensaje del tipo anterior (''Job Execution Request''), y status es el estado del trabajo.
+
+El contenido del mensaje se tratará como texto plano y se guardará tal cual en la base de datos del servidor, para que posteriormente sea procesador por la función de callback de dicho Job, si tuviera. 
+
+Es una práctica común que dicho mensaje, que proviene de un comando ejecutado en el cliente (ya sea un comando nativo o de OGR) esté codificado en JSON, y que la función de callback lo procese como tal a partir del texto del mensaje en la BD, pero no es necesario. De hecho, lo normal es que sólo algunos comandos de OGR estén codificados en JSON, puesto que los comandos nativos de Linux no suelen devolver su salida en formato JSON.
+
+La cadena ''status'' puede ser:
+* '''FINISHED''', que significa que el trabajo ha terminado correctamente.
+* '''ERROR''', si la ejecución del comando dio algún tipo de error.
+* '''INPROGRESS''', cuando se trata de un trabajo lento para indicar al servidor que sigue en ejecución.
+
+== Job Progress Update ==
+
+Un mensaje de tipo ''Job Progress Update'' es enviado desde el servicio job executer de un cliente al servicio job receiver de un servidor opengnsys. El objetivo de este mensaje es mandar información actualizada referente al progreso de la ejecución de un comando desde el cliente al servidor.
+
+La petición debe ir a la url {{{/updatejob/progress/(?P<id>\d+)/(?P<progress>\d+)}}}. El id es único y se refiere al id del trabajo (Job) que fue recibido por el cliente en un mensaje del tipo anterior (''Job Execution Request''), y progress indica el porcentaje de finalización (un número de 0 a 100) del trabajo.
+
+El contenido del mensaje se tratará como texto plano, suele ser un corto texto de una línea y se guardará tal cual en la base de datos del servidor, para que posteriormente sea procesador por la función de callback de dicho Job, si tuviera.