From d5e1eef9052dcddcdc2618a9c836c97d65b4292b Mon Sep 17 00:00:00 2001 From: Nicolas Hoizey Date: Tue, 4 May 2021 17:24:31 +0200 Subject: Fix heading id for anchor link / Update page (#749) * Fix heading id for anchor link I looked at another French pages to use the same id: https://github.com/mdn/translated-content/blob/main/files/fr/web/svg/attribute/stroke-opacity/index.html * Update vs en-US + rm macros Co-authored-by: julieng --- .../using_server-sent_events/index.html | 156 +++++++++++---------- 1 file changed, 83 insertions(+), 73 deletions(-) (limited to 'files/fr/web/api') diff --git a/files/fr/web/api/server-sent_events/using_server-sent_events/index.html b/files/fr/web/api/server-sent_events/using_server-sent_events/index.html index 49c3a7823f..bb817baf5a 100644 --- a/files/fr/web/api/server-sent_events/using_server-sent_events/index.html +++ b/files/fr/web/api/server-sent_events/using_server-sent_events/index.html @@ -1,133 +1,145 @@ --- title: Utiliser les évènements envoyés par le serveur slug: Web/API/Server-sent_events/Using_server-sent_events +tags: + - Advanced + - Communication + - DOM + - Guide + - SSE + - Server Sent Events + - Server-sent events + - messaging translation_of: Web/API/Server-sent_events/Using_server-sent_events --- -

Développer une application web qui utilise des server-sent events (évènements envoyés par le serveur) est assez facile. Vous aurez besoin d’un bout de code côté serveur pour transmettre des évènements en flux continu à l’application web ; mais côté client, les choses fonctionnent de manière quasiment identique à la gestion de n’importe quel autre type d’évènement.

+

{{DefaultAPISidebar("Server Sent Events")}}

+

Développer une application web qui utilise des évènements envoyés par le serveur (server-sent events en anglais) est relativement simple. Côté serveur, on aura besoin d'un bout de code qui puisse transmettre des évènements à l'application web ; côté client, le fonctionnement est quasi identique à celui qu'on utilise pour les websockets et notamment la gestion d'évènements entrants. Il s'agit d'une connexion unidirectionnelle : on ne peut pas envoyer d'évènements du client vers le serveur.

-

Recevoir des évènements du serveur

+

Recevoir des évènements du serveur

-

L’API server-sent events est exposée par l’interface EventSource ; pour ouvrir une connexion vers le serveur afin de commencer à recevoir des évènements de celui-ci, vous devez créer un nouvel objet EventSource, en spécifiant l’URL d’un script côté serveur qui va générer les évènements. Par exemple :

+

L'API des évènements serveur est exposée par l'interface EventSource ; pour ouvrir une connexion vers le serveur afin de commencer à recevoir des évènements de celui-ci, on crée un nouvel objet EventSource, en spécifiant l'URL d'un script côté serveur qui va générer les évènements. Par exemple :

-
var evtSource = new EventSource("ssedemo.php");
+
const evtSource = new EventSource("ssedemo.php");
 

 
-
Si le script qui génère les évènements est hébergé sur un domaine différent, le nouvel objet EventSource doit être créé en spécifiant à la fois l’URI et un dictionnaire d’options. Par exemple, en supposant que le script client est sur example.com :

+
Si le script qui génère les évènements est hébergé sur une origine différente, le nouvel objet EventSource doit être créé en spécifiant à la fois l'URL et un dictionnaire d'options. Par exemple, en supposant que le script client est sur example.com :

 
-
var evtSource = new EventSource("//api.example.com/ssedemo.php", { withCredentials: true } );

+
const evtSource = new EventSource("//api.example.com/ssedemo.php", { withCredentials: true } );

 
-

-
Note : l’utilisation d’EventSource n’est pas supportée par tous les navigateurs. Veuillez vérifier la section {{ anch("Compatibilité des navigateurs") }}.

-

+
Une fois que la source d'évènement a été instanciée, on peut écouter les messages provenant du serveur en attachant un gestionnaire d'évènement pour message :

 
-
Une fois que vous avez instancié votre source d’évènement, vous pouvez commencer à surveiller les messages du serveur, en écoutant l’évènement message :

+
evtSource.onmessage = function(event) {
+  const newElement = document.createElement("li");
+  const eventList = document.getElementById("list");
 
-
evtSource.onmessage = function(e) {
-  var newElement = document.createElement("li");
-
-  newElement.innerHTML = "message: " + e.data;
+  newElement.textContent = "message: " + event.data;
   eventList.appendChild(newElement);
 }
 

 
-
Ce code écoute les messages entrants (plus précisément, les notifications venant du serveur qui n’ont pas de champ event attaché) et ajoute le texte des messages à une liste dans le HTML du document.

-
-
Vous pouvez aussi écouter les évènements avec addEventListener() :

+
Ce code écoute les messages entrants (plus précisément, les notifications venant du serveur qui n'ont pas de champ event attaché) et ajoute le texte des messages à une liste dans le contenu HTML du document.

 
-
evtSource.addEventListener("ping", function(e) {
-  var newElement = document.createElement("li");
+
On peut aussi écouter les évènements avec addEventListener() :

 
-  var obj = JSON.parse(e.data);
-  newElement.innerHTML = "ping at " + obj.time;
+
evtSource.addEventListener("ping", function(event) {
+  const newElement = document.createElement("li");
+  const time = JSON.parse(event.data).time;
+  newElement.textContent = "ping at " + time;
   eventList.appendChild(newElement);
-}, false);
+});
 

 
-
Ce code est similaire, à part qu’il sera appelé automatiquement si le serveur envoie un message dont le champ event est ping ; il analysera alors le JSON dans le champ data et l’affichera.

+
Ce fragment de code est similaire au précédent, mais sera appelé automatiquement si le serveur envoie un message dont le champ event est ping ; il analysera alors le JSON dans le champ data et l'affichera.

 
-
Envoyer un évènement depuis le serveur

+

+  
Lorsque HTTP/2 n'est pas utilisé, les évènements serveurs sont limités par le nombre maximal de connexion ouvertes, notamment quand on a plusieurs onglets ouverts. La limite est fixée par le navigateur et vaut 6 pour chaque origine (voir les bugs Chrome et Firefox). On pourra avoir 6 connexions pour les évènements serveurs parmi tous les onglets ouverts sur www.example1.com, 6 autres pour tous les onglets sur www.example2.com (voir cette réponse Stack Overflow). Avec HTTP/2, le nombre de flux HTTP simultanés est négocié entre le serveur et le client et vaut 100 par défaut.

+

+
+
Envoyer un évènement depuis le serveur

 
-
Le script côté serveur qui envoie les évènements doit répondre en utilisant le type MIME text/event-stream. Chaque notification est envoyée sous la forme d’un bloc de texte se terminant par une paire de caractères saut de ligne (\n). Pour plus de détails sur le format du flux d’évènements, voir {{ anch("Format du flux d'évènements") }}.

+
Le script côté serveur qui envoie les évènements doit répondre en utilisant le type MIME text/event-stream. Chaque notification est envoyée sous la forme d'un bloc de texte se terminant par une paire de caractères saut de ligne (\n). Pour plus de détails sur le format du flux d'évènements, voir la section ci-après.

 
-
Voici le code {{ Glossary("PHP") }} que nous utilisons pour notre exemple :

+
Voici le code PHP que nous utilisons pour notre exemple :

 
 
date_default_timezone_set("America/New_York");
-header("Content-Type: text/event-stream\n\n");
+header("Cache-Control: no-cache");
+header("Content-Type: text/event-stream");
 
 $counter = rand(1, 10);
-while (1) {
-  // Chaque seconde, envoi d’un évènement "ping".
+while (true) {
+  // Chaque seconde, on envoie un évènement "ping".
 
   echo "event: ping\n";
   $curDate = date(DATE_ISO8601);
   echo 'data: {"time": "' . $curDate . '"}';
-  // Paire de sauts de ligne
   echo "\n\n";
 
-  // Envoie un message simple à des intervalles aléatoires.
+  // Envoi d'un message simple à fréquence aléatoire.
 
   $counter--;
 
   if (!$counter) {
-    echo 'data: This is a message at time ' . $curDate . "\n\n";
+    echo 'data: Message envoyé à ' . $curDate . "\n\n";
     $counter = rand(1, 10);
   }
 
   ob_end_flush();
   flush();
+
+  // On ferme la boucle si le client a interrompu la connexion
+  // (par exemple en fermant la page)
+
+  if ( connection_aborted() ) break;
+
   sleep(1);
 }
 

 
-
Ce code génère un évènement de type « ping » à chaque seconde. La donnée de chaque évènement est un objet JSON contenant un horodatage ISO 8601 qui correspond à l’heure à laquelle l’évènement a été généré. À des intervalles aléatoires, un message simple (sans type d’évènement) est envoyé.

+
Ce code génère un évènement de type « ping » à chaque seconde. La donnée de chaque évènement est un objet JSON contenant un horodatage ISO 8601 qui correspond à l'heure à laquelle l'évènement a été généré. À des intervalles aléatoires, un message simple (sans type d'évènement) est envoyé.

+
La boucle s'exécute indépendamment du statut de la connexion, on a donc une vérification pour terminer l'exécution si la connexion a été terminée.

 
 

-
Note : Vous pouvez trouver un exemple complet utilisant le code ci-dessus sur Github — voir Simple SSE demo using PHP.

+
Note : Vous pouvez trouver un exemple complet utilisant le code ci-dessus sur GitHub : voir Démonstration d'évènements serveur avec PHP.

 

 
-
Gestion des erreurs

+
Gestion des erreurs

 
-
Quand un problème survient (tel qu’un délai de réponse dépassé ou une erreur liée au contrôle d’accès), un évènement error est généré. Vous pouvez traiter ces cas d’erreur en implémentant la fonction de rappel onerror de l’objet EventSource.

+
Quand un problème survient (tel qu'un délai de réponse dépassé ou une erreur liée au contrôle d'accès), un évènement error est généré. Vous pouvez traiter ces cas d'erreur en implémentant la fonction de rappel onerror sur l'objet EventSource.

 
-
evtSource.onerror = function(e) {
-  alert("EventSource failed.");
+
evtSource.onerror = function(err) {
+  console.error("EventSource failed:", err);
 };
 

 
-
À l’heure de Firefox 60, il ne semble pas exister de moyen de distinguer les différents types d’erreur.

+
Fermer les flux d'évènements

 
-
Fermer un flux d’évènements

+
Par défaut, si la connexion entre le client et le serveur est rompue, elle sera relancée. Il est possible de la fermer explicitement à l'aide de la méthode .close().

 
-
Par défaut, si la connexion entre le client et le serveur est rompue, elle sera relancée. Il est possible de la fermer explicitement à l’aide de la méthode .close().

+
evtSource.close();

 
-
evtSource.close();

+
Format du flux d'évènements

 
-
Format du flux d’évènements

-
-
Le flux d’évènements est un simple flux de données de texte, qui doivent être encodées en UTF-8. Les messages dans le flux d’évènements sont séparés par une paire de sauts de ligne. Un caractère deux-points « : » en début de ligne est essentiellement un commentaire, et est ignoré.

+
Le flux d'évènements est un simple flux de données de texte, qui doit être encodé en UTF-8. Les messages dans le flux d'évènements sont séparés par une paire de sauts de ligne. Un caractère deux-points « : » en début de ligne représente un commentaire, et est ignoré.

 
 

-
Note : Une ligne de commentaire peut être utilisée pour empêcher les connexions d’expirer. Un serveur peut envoyer périodiquement des commentaires afin de garder la connexion ouverte.

+
Note : Une ligne de commentaire peut être utilisée pour empêcher les connexions d'expirer. Un serveur peut envoyer périodiquement des commentaires afin de garder la connexion ouverte.

 

 
-
Chaque message consiste en une ou plusieurs lignes de texte décrivant les champs de ce message. Chaque champ est représenté par le nom du champ, suivi d’un « : », suivi des données de texte pour la valeur de ce champ.

+
Chaque message consiste en une ou plusieurs lignes de texte décrivant les champs de ce message. Chaque champ est représenté par le nom du champ, suivi d'un « : », suivi des données de texte pour la valeur de ce champ.

 
-
Champs

+
Champs

 
-
Chaque message reçu a une combinaison quelconque des champs suivants, un par ligne ·

+
Chaque message reçu contient un ou plusieurs de ces champs, un par ligne  :

 
 

  
event

- 
Une chaîne identifiant le type d’évènement décrit. S’il est spécifié, un évènement sera envoyé dans le navigateur à l’écouteur défini pour l’évènement spécifié. Le code source de l’application doit utiliser addEventListener() pour écouter des évènements nommés. Le gestionnaire onmessage est appelé si aucun nom d’évènement n’est spécifié dans un message.

+ 
Une chaîne identifiant le type d'évènement décrit. S'il est spécifié, un évènement sera envoyé dans le navigateur à l'écouteur défini pour l'évènement spécifié. Le code source de l'application doit utiliser addEventListener() pour écouter des évènements nommés. Le gestionnaire onmessage est appelé si aucun nom d'évènement n'est spécifié dans un message.

  
data

- 
Le champ de données du message. Lorsque l’EventSource reçoit plusieurs lignes de message consécutives commençant par data:, il les concatène, en ajoutant un caractère saut de ligne entre chacune d’elles. Les sauts de ligne en fin de message sont supprimés.

+ 
Le champ de données du message. Lorsque l'EventSource reçoit plusieurs lignes de message consécutives commençant par data:, il les concatène, en ajoutant un caractère saut de ligne entre chacune d'elles. Les sauts de ligne en fin de message sont supprimés.

  
id

- 
L’ID d’évènement, qui sera mémorisé comme valeur d’ID du dernier évènement de l’objet EventSource.

-

-
-

+ 
L'identifiant d'évènement, qui sera mémorisé comme valeur d'identifiant du dernier évènement de l'objet EventSource.

  
retry

- 
Le délai de reconnexion à utiliser lors de la tentative d’envoi de l’évènement. Il doit être un nombre entier, spécifiant le temps de reconnexion en millisecondes. Si une valeur non entière est spécifiée, le champ est ignoré.

+ 
Le délai de reconnexion à utiliser lors de la tentative d'envoi de l'évènement. Il doit être un nombre entier, spécifiant le temps de reconnexion en millisecondes. Si une valeur non entière est spécifiée, le champ est ignoré.

 

 
 
Tous les autres noms de champs sont ignorés.

@@ -136,27 +148,27 @@ while (1) {
 
Note : Si une ligne ne contient aucun caractère deux-points, la ligne entière est considérée comme le nom du champ, avec un contenu vide.

 
 
-
Exemples

+
Exemples

 
-
Messages de données seulement

+
Messages contenant uniquement des données

 
-
Dans l’exemple suivant, trois messages sont envoyés. Le premier est simplement un commentaire, car il débute par un caractère deux-points. Comme mentionné précédemment, cela peut être utile pour maintenir la connexion si des messages doivent être transmis de façon irrégulière.

+
Dans l'exemple suivant, trois messages sont envoyés. Le premier est simplement un commentaire, car il débute par un caractère deux-points. Comme mentionné précédemment, cela peut être utile pour maintenir la connexion si des messages doivent être transmis de façon irrégulière.

 
-
Le second message contient un champ data avec la valeur "some text". Le troisième message contient un champ data avec la valeur "another message\nwith two lines". Notez le caractère saut de ligne dans la valeur.

+
Le deuxième message contient un champ data avec la valeur "du texte". Le troisième message contient un champ data avec la valeur "un autre message\nsur deux lignes". On notera le caractère saut de ligne dans la valeur.

 
-
: this is a test stream
+
: this is a test stream
 
-data: some text
+data: du texte
 
-data: another message
-data: with two lines
+data: un autre message
+data: sur deux lignes
 

 
-
Évènements nommés

+
Évènements nommés

 
-
Cet exemple envoie une série d’évènements nommés. Chacun a un nom d’évènement spécifié par le champ event, et un champ data dont la valeur est une chaîne JSON appropriée avec les données nécéssaires au client pour réagir à l’évènement. Le champ data peut évidemment contenir n’importe quelles données de texte , il n’est pas obligatoirement au format JSON.

+
Cet exemple envoie une série d'évènements nommés. Chacun a un nom d'évènement spécifié par le champ event, et un champ data dont la valeur est une chaîne JSON appropriée avec les données nécessaires au client pour réagir à l'évènement. Le champ data peut évidemment contenir n'importe quelles données textuelles, il n'est pas obligatoirement au format JSON.

 
-
event: userconnect
+
event: userconnect
 data: {"username": "bobby", "time": "02:33:48"}
 
 event: usermessage
@@ -169,11 +181,11 @@ event: usermessage
 data: {"username": "sean", "time": "02:34:36", "text": "Bye, bobby."}
 

 
-
Mélanger les messages

+
Mélanger les types de message

 
-
Il n’est pas obligatoire d’utiliser uniquement des messages sans nom ou des évènements nommés. Vous pouvez mélanger les deux dans un même flux d’évènements.

+
Il n'est pas obligatoire d'utiliser uniquement des messages sans nom ou des évènements nommés. Vous pouvez mélanger les deux dans un même flux d'évènements.

 
-
event: userconnect
+
event: userconnect
 data: {"username": "bobby", "time": "02:33:48"}
 
 data: Ici un message système quelconque qui sera utilisé
@@ -184,6 +196,4 @@ data: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}

 
 
Compatibilité des navigateurs

 
-
EventSource

-
-
{{Compat("api.EventSource")}}

\ No newline at end of file
+
{{Compat("api.EventSource")}}

-- 
cgit v1.2.3-54-g00ecf