WebSocket.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.
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
codeFacultatif-
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
CloseEventpour les valeurs autorisées. reasonFacultatif-
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
reasonest 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> # dom-websocket-close> |
Compatibilité des navigateurs
Chargement…