WebSocket.close()
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.
La méthode WebSocket.close()
ferme la connexion WebSocket
ou interrompt l'éventuelle tentative de connexion. Si la connexion est déjà fermée (état CLOSED
), cette méthode ne fait rien.
Syntaxe
WebSocket.close();
WebSocket.close(code);
WebSocket.close(reason);
WebSocket.close(code, reason);
Paramètres
code
Facultatif-
Une valeur numérique indiquant le code de statut qui explique pourquoi la connexion est fermée. Si ce paramètre n'est pas fourni, 1005 sera la valeur par défaut. Voir la liste des codes de statut de
CloseEvent
pour les valeurs autorisées. reason
Facultatif-
Une chaîne de caractères, lisible et compréhensible par un humain qui explique pourquoi la connexion est fermée. Cette chaîne ne doit pas être plus longue que 123 octets de texte UTF-8 (attention, cela ne signifie pas 123 caractères).
Exceptions levées
INVALID_ACCESS_ERR
-
Un code invalide a été fourni avec
code
. SYNTAX_ERR
-
La chaîne de caractères pour
reason
est trop longue ou contient dessurrogates
non appairés.
Note : Avant Gecko 8.0, cette méthode ne prenait en charge aucun paramètre.
Spécifications
Specification |
---|
WebSockets Standard # ref-for-dom-websocket-close① |
Compatibilité des navigateurs
BCD tables only load in the browser