(no commit message)
[euphorik.git] / js / comet.js
index 9b4d0ee..e06f518 100644 (file)
 /**\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' 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" du serveur\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
@@ -66,7 +66,7 @@ Comet.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