MOD avancement dans le module 'communication'

[euphorik.git] / js / comet.js

diff --git a/js/comet.js b/js/comet.js
index f26a325..3cd1b17 100644 (file)
--- a/js/comet.js
+++ b/js/comet.js
@@ -19,31 +19,33 @@
 /*jslint laxbreak:true */\r
 \r
 /**\r
-   * Permet de gérer les événements (push serveur).\r
-   * Principe de fonctionnement :\r
-   *  - La page courante créer un objet euphorik.PageEvent en indiquant le nom de la page\r
-   *  - La page courante attend un événement en appelant 'waitEvent' et en donnant deux fonctions :\r
-   *    - 'funSend' une fonction qui renvoie les données à envoyer avant l'attente, par exemple {"dernierMess" : 23}\r
-   *       "header" et "page" seront ajoutés aux données\r
-   *    - 'funsReceive' un ensemble de fonctions à appeler en fonction du "reply" sur serveur\r
-   *\r
-   * l'information envoyé est sous la forme :\r
-   *  {\r
-   *     "header" : {"action" : "wait_event", "version" : <v> },\r
-   *     "page" : <page>\r
-   *     [..]\r
-   *  }\r
-   * l'information reçu est sous la forme :\r
-   *  {\r
-   *     "reply" : <reply>\r
-   *     [..]\r
-   *  }\r
-   * @page la page courante pour laquelle on écoute des événements (un string)\r
-   * @util le helper 'util'\r
-   */\r
-euphorik.PageEvent = function(page, util) {\r
+  * Permet de gérer les événements (push serveur).\r
+  * Principe de fonctionnement :\r
+  *  - La page courante créer un objet euphorik.Comet en indiquant le nom de la page et la version du protocole.\r
+  *  - La page courante attend un événement en appelant 'waitEvent' (non-bloquant) et en donnant deux fonctions :\r
+  *    - 'funSend' une fonction qui renvoie l'objet à envoyer avant l'attente, par exemple {"dernierMess" : 23}\r
+  *       ("header" et "page" sont automatiquement ajoutés à l'objet)\r
+  *    - 'funsReceive' un ensemble de fonctions à appeler en fonction du "reply" du serveur, par exemple {"set_nom" : function(data) { print("ok : " + data.nom); } }\r
+  *\r
+  * l'information envoyée est sous la forme :\r
+  *  {\r
+  *     "header" : {"action" : "wait_event", "version" : <v> },\r
+  *     "page" : <page>\r
+  *     [..]\r
+  *  }\r
+  * l'information reçue est sous la forme :\r
+  *  {\r
+  *     "reply" : <reply>\r
+  *     [..]\r
+  *  }\r
+  * <reply> et <page> sont de type chaine\r
+  *\r
+  * @page [string] la page courante pour laquelle on écoute des événements (un string)\r
+  * @util [int] la version\r
+  */\r
+Comet = function(page, version) {\r
    this.page = page;\r
-   this.util = util;\r
+   this.version = version;\r
    \r
    // l'objet JSONHttpRequest représentant la connexion d'attente\r
    this.attenteCourante = undefined;\r
@@ -55,7 +57,7 @@ euphorik.PageEvent = function(page, util) {
 /**\r
   * Arrête l'attente courante s'il y en a une.\r
   */\r
-euphorik.PageEvent.prototype.stopAttenteCourante = function() {\r
+Comet.prototype.stopAttenteCourante = function() {\r
    this.stop = true;\r
          \r
    if (this.attenteCourante) {\r
@@ -64,23 +66,23 @@ euphorik.PageEvent.prototype.stopAttenteCourante = function() {
 };\r
 \r
 /**\r
-  * Attend un événement lié à la page. \r
+  * Attend un événement lié à la page. Non-bloquant. \r
   * @funSend une fonction renvoyant les données json à envoyer\r
   * @funsReceive est un objet comprenant les fonctions à appeler en fonction du "reply"\r
   * les fonctions acceptent un paramètre correspondant au données reçues.\r
   * exemple : {"new_message" : function(data){ ... }}\r
   */\r
-euphorik.PageEvent.prototype.waitEvent = function(funSend, funsReceive) {\r
+Comet.prototype.waitEvent = function(funSend, funsReceive) {\r
    this.stopAttenteCourante();\r
    \r
    this.stop = false;\r
    \r
-   var thisPageEvent = this;\r
+   var thisComet = this;\r
       \r
    // on doit conserver l'ordre des valeurs de l'objet JSON (le serveur les veut dans l'ordre définit dans le protocole)\r
    // TODO : ya pas mieux ?\r
    var dataToSend = {\r
-      "header" : { "action" : "wait_event", "version" : euphorik.conf.versionProtocole },\r
+      "header" : { "action" : "wait_event", "version" : this.version },\r
       "page" : this.page\r
    };\r
    var poulpe = funSend();\r
@@ -94,18 +96,18 @@ euphorik.PageEvent.prototype.waitEvent = function(funSend, funsReceive) {
       dataType: "json",\r
       // TODO : doit disparaitre\r
       timeout: 180000, // timeout de 3min. Gros HACK pas beau. FIXME problème décrit ici : http://groups.google.com/group/jquery-en/browse_thread/thread/8724e64af3333a76\r
-      data: this.util.jsonVersAction(dataToSend),\r
+      data: { action : JSON.stringify(dataToSend) },\r
       success:\r
-         function(data) {                        \r
+         function(data) {\r
             funsReceive[data.reply](data);\r
-            \r
+         \r
             // rappel de la fonction dans 100 ms\r
-            setTimeout(function(){ thisPageEvent.waitEvent2(funSend, funsReceive); }, 100);\r
+            setTimeout(function(){ thisComet.waitEvent2(funSend, funsReceive); }, 100);\r
          },\r
       error:\r
          function(XMLHttpRequest, textStatus, errorThrown) {\r
             ;; console.log("Connexion perdue dans PageEvent.prototype.waitEvent()");\r
-            setTimeout(function(){ thisPageEvent.waitEvent2(funSend, funsReceive); }, 1000);\r
+            setTimeout(function(){ thisComet.waitEvent2(funSend, funsReceive); }, 1000);\r
          }\r
    });\r
 };\r
@@ -113,7 +115,7 @@ euphorik.PageEvent.prototype.waitEvent = function(funSend, funsReceive) {
 /**\r
   * Si un stopAttenteCourante survient un peu n'importe quand il faut imédiatement arreter de boucler.\r
   */\r
-euphorik.PageEvent.prototype.waitEvent2 = function(funSend, funsReceive) {\r
+Comet.prototype.waitEvent2 = function(funSend, funsReceive) {\r
    if (this.stop) {\r
       return;\r
    }\r