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.
Die close()-Methode des WebSocketStream-Interfaces schließt die WebSocket-Verbindung. Die Methode akzeptiert optional ein Objekt, das einen benutzerdefinierten Code und/oder Grund enthält, warum die Verbindung geschlossen wurde.
Syntax
close()
close(options)
Parameter
optionsOptional-
Ein Optionsobjekt mit den folgenden Eigenschaften:
closeCodeOptional-
Eine Zahl, die den Schließungscode repräsentiert (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 es sein, dass der Server einen benutzerdefinierten Code ignoriert und stattdessen einen gültigen Code verwendet, der für den Schließungsgrund korrekt ist. Gültige Codes sind 1000 und jeder Code im Bereich von 3000 bis einschließlich 4999.
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
Loading…
Siehe auch
- WebSocketStream: Einbindung von Streams mit der WebSocket-API, developer.chrome.com (2020)