CloseEvent
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Un évènement CloseEvent
est envoyé au client utilisant une WebSocket lorsque la connexion est fermée. Cet évènement est envoyé au listener
indiqué par l'attribut onclose
de la WebSocket
.
Constructeur
CloseEvent()
-
Construit un nouvel événement
CloseEvent
.
Propriétés
Cette interface hérite également des propriétés de sa mère, Event
.
CloseEvent.code
Lecture seule-
Retourne un
unsigned short
contenant le code de fermeture envoyé par le serveur. Les valeurs possibles sont données ci-dessous.Status code Nom Description 0
–999
Reservé et inutilisé. 1000
CLOSE_NORMAL
Fermeture normale ; la connexion s'est terminée normalement. 1001
CLOSE_GOING_AWAY
Reçu lorsque une erreur est apparue sur le serveur ou le navigateur quitte la page ayant ouvert la connexion.
1002
CLOSE_PROTOCOL_ERROR
L'autre partie de la connexion termine la connexion à cause d'une erreur de protocole. 1003
CLOSE_UNSUPPORTED
La connexion est terminée car le serveur à reçu des données d'un type qu'il ne peut pas accepter (par exemple des données binaire plutôt que du texte). 1004
Réservé. Une utilisation pourrait être définie dans le futur. 1005
CLOSE_NO_STATUS
Réservé. Indique qu'aucun code n'est donné bien qu'un code était attendu. 1006
CLOSE_ABNORMAL
Réservé. Utilisé pour indiquer que la connexion a été terminée anormalement (sans paquet indiquant la fermeture). 1007
Le serveur termine la connexion car un message contenant des données incohérentes a été reçu (e.g., des données qui ne sont pas au format UTF-8 dans un message texte). 1008
Le serveur termine la connexion car un message ne respectant pas la politique du serveur est reçu. C'est un code d'état générique qui est utilisé lorsque les codes 1003 et 1009 ne correspondent pas à la situation. 1009
CLOSE_TOO_LARGE
Le serveur termine la connexion car les données reçues sont trop grosses. 1010
Le client termine la connexion car il souhaitait négocier une ou plusieurs extensions mais le serveur ne l'a pas fait. 1011
Le serveur termine la connexion car il a rencontré un problème qui l'empêche de traiter la requête. – 1014
Réservé pour une utilisation future par le standard WebSocket. 1015
Réservé. Indique que la connexion a été fermée à cause d'une erreur durant le handshake TLS (e.g., le certificat du serveur ne peut pas être vérifié). 1016
–1999
Réservé pour une utilisation future par le standard WebSocket. 2000
–2999
Réservé pour une utilisation future par le standard WebSocket. 3000
–3999
Disponible pour être utilisé par des bibliothèques ou des frameworks. Ces codes ne doivent pas être utilisés par des applications. 4000
–4999
Disponible pour être utilisés par des applications. CloseEvent.reason
Lecture seule-
Retourne un
DOMString
qui indique la raison pour laquelle le serveur a fermé la connexion. Ce message est spécifique au serveur et au sous-protocole utilisé. CloseEvent.wasClean
Lecture seule-
Retourne un
Boolean
qui indique si la connexion a été correctement fermée ou non.
Méthodes
Cette interface hérite également des propriétés de sa mère, Event
.
CloseEvent.initCloseEvent()
Non-standard Obsolète-
Initialise la valeur d'un
CloseEvent
. Si l'événement a déjà été envoyé, cette méthode ne fait rien.
Spécifications
Specification |
---|
WebSockets Standard # the-closeevent-interface |
Compatibilité des navigateurs
BCD tables only load in the browser