WebSocket : évènement close
Baseline
Widely available
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.
Note : Cette fonctionnalité est disponible via les Web Workers.
L'évènement close de l'interface WebSocket est déclenché lorsqu'une connexion avec une WebSocket est fermée.
Syntaxe
Utilisez le nom de l'évènement dans des méthodes comme addEventListener(), ou assignez une propriété de gestionnaire d'évènement.
addEventListener("close", (event) => { })
onclose = (event) => { }
Type d'évènement
Un objet CloseEvent. Hérite de l'objet Event.
Propriétés de l'évènement
En plus des propriétés listées ci-dessous, les propriétés de l'interface parente, Event, sont disponibles.
codeLecture seule-
Retourne une valeur de type
unsigned shortcontenant le code de fermeture envoyé par le serveur. reasonLecture seule-
Retourne une chaîne de caractères indiquant la raison pour laquelle le serveur a fermé la connexion. Ceci est spécifique au serveur et au sous-protocole concernés.
wasCleanLecture seule-
Retourne une valeur booléenne indiquant si la connexion a été fermée proprement ou non.
Exemples
Vous pourriez vouloir savoir quand la connexion a été fermée afin de mettre à jour l'interface utilisateur ou, peut-être, enregistrer des données concernant la connexion fermée. En supposant que vous ayez une variable appelée socketExemple qui fait référence à une WebSocket ouverte, ce gestionnaire permettrait de gérer la situation où la socket a été fermée.
socketExemple.addEventListener("close", (event) => {
console.log("La connexion a été fermée avec succès.");
});
On peut effectuer les mêmes actions avec la propriété de gestion d'évènement correspondante :
socketExemple.onclose = (event) => {
console.log("La connexion a été fermée avec succès.");
};
Spécifications
| Specification |
|---|
| WebSockets # dom-websocket-onclose |