2 // Copyright 2008 Grégory Burri
4 // This file is part of Euphorik.
6 // Euphorik is free software: you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation, either version 3 of the License, or
9 // (at your option) any later version.
11 // Euphorik is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with Euphorik. If not, see <http://www.gnu.org/licenses/>.
19 /*jslint laxbreak:true */
22 * Permet de gérer les événements (push serveur).
23 * Principe de fonctionnement :
24 * - La page courante créer un objet euphorik.Comet en indiquant le nom de la page et la version du protocole.
25 * - La page courante attend un événement en appelant 'waitEvent' (non-bloquant) et en donnant deux fonctions :
26 * - 'funSend' une fonction qui renvoie l'objet à envoyer avant l'attente, par exemple {"dernierMess" : 23}
27 * ("header" et "page" sont automatiquement ajoutés à l'objet)
28 * - 'funsReceive' un ensemble de fonctions à appeler en fonction du "reply" du serveur, par exemple {"set_nom" : function(data) { print("ok : " + data.nom); } }
30 * l'information envoyée est sous la forme :
32 * "header" : {"action" : "wait_event", "version" : <v> },
36 * l'information reçue est sous la forme :
41 * <reply> et <page> sont de type chaine
43 * @page [string] la page courante pour laquelle on écoute des événements (un string)
44 * @util [int] la version
46 Comet = function(page
, version
) {
48 this.version
= version
;
50 // l'objet JSONHttpRequest représentant la connexion d'attente
51 this.attenteCourante
= undefined;
53 // le multhreading du pauvre, merci javascript de m'offrire autant de primitives pour la gestion de la concurrence...
58 * Arrête l'attente courante s'il y en a une.
60 Comet
.prototype.stopAttenteCourante = function() {
63 if (this.attenteCourante
) {
64 this.attenteCourante
.abort();
69 * Attend un événement lié à la page. Non-bloquant.
70 * @funSend une fonction renvoyant les données json à envoyer
71 * @funsReceive est un objet comprenant les fonctions à appeler en fonction du "reply"
72 * les fonctions acceptent un paramètre correspondant au données reçues.
73 * exemple : {"new_message" : function(data){ ... }}
75 Comet
.prototype.waitEvent = function(funSend
, funsReceive
) {
76 this.stopAttenteCourante();
82 // on doit conserver l'ordre des valeurs de l'objet JSON (le serveur les veut dans l'ordre définit dans le protocole)
83 // TODO : ya pas mieux ?
85 "header" : { "action" : "wait_event", "version" : this.version
},
88 var poulpe
= funSend();
89 objectEach(poulpe
, function(k
, v
) {
93 this.attenteCourante
= jQuery
.ajax({
97 // TODO : doit disparaitre
98 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
99 data: { action : JSON
.stringify(dataToSend
) },
102 funsReceive
[data
.reply
](data
);
104 // rappel de la fonction dans 100 ms
105 setTimeout(function(){ thisComet
.waitEvent2(funSend
, funsReceive
); }, 100);
108 function(XMLHttpRequest
, textStatus
, errorThrown
) {
109 ;; console
.log("Connexion perdue dans Comet.prototype.waitEvent() : \n" + textStatus
);
110 setTimeout(function(){ thisComet
.waitEvent2(funSend
, funsReceive
); }, 1000);
116 * Si un stopAttenteCourante survient un peu n'importe quand il faut imédiatement arreter de boucler.
118 Comet
.prototype.waitEvent2 = function(funSend
, funsReceive
) {
122 this.waitEvent(funSend
, funsReceive
);