WebSocketStream: close()-Methode
Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.
Die close()-Methode der WebSocketStream-Schnittstelle beendet die WebSocket-Verbindung. Die Methode kann optional ein Objekt akzeptieren, das einen benutzerdefinierten Code und/oder einen Grund enthält, warum die Verbindung geschlossen wurde.
Syntax
close()
close(options)
Parameter
optionsOptional-
Ein Optionen-Objekt, das die folgenden Eigenschaften enthält:
closeCodeOptional-
Eine Zahl, die den Schließcode darstellt (siehe die vollständige Liste der
CloseEvent-Statuscodes). reasonOptional-
Ein String, der eine menschenlesbare Beschreibung des Grundes darstellt, warum die Socket-Verbindung geschlossen wird. Die maximal erlaubte Länge für einen
reason-String beträgt 123 Bytes. Der String wird automatisch als UTF-8 kodiert, wenn die Funktion aufgerufen wird.
Hinweis: Abhängig von der Serverkonfiguration und dem verwendeten Statuscode kann der Server einen benutzerdefinierten Code ignorieren und stattdessen einen gültigen Code wählen, der für den Schließgrund korrekt ist. Gültige Codes sind 1000 und jeder Code im Bereich von 3000 bis 4999, inklusive.
Rückgabewert
Keiner (undefined).
Ausnahmen
SyntaxErrorDOMException-
Wird ausgelöst, wenn der angegebene
reasonlänger als die maximal erlaubte Länge von 123 Bytes ist.
Beispiele
const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);
setTimeout(() => {
wss.close({
closeCode: 1000,
reason: "That's all folks",
});
}, 10000);
Spezifikationen
Derzeit nicht Teil einer Spezifikation. Siehe https://github.com/whatwg/websockets/pull/48 für den Standardisierungsfortschritt.
Browser-Kompatibilität
Siehe auch
- WebSocketStream: integration von Streams mit der WebSocket-API, developer.chrome.com (2020)