WebSocketStream: Eigenschaft closed
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 schreibgeschützte Eigenschaft closed des WebSocketStream-Interfaces gibt ein Promise zurück, das mit einem Objekt erfüllt wird, sobald die Socket-Verbindung geschlossen ist. Das Objekt enthält den Schließungscode und den Grund.
Wert
Ein Promise, das mit einem Objekt erfüllt wird, das die folgenden Eigenschaften enthält:
closeCode-
Eine Zahl, die den Schließungscode darstellt (siehe die vollständige Liste der
CloseEvent-Statuscodes). reason-
Ein String, der eine menschenlesbare Beschreibung des Grundes darstellt, warum die Socket-Verbindung geschlossen wurde.
Das Promise wird abgelehnt, wenn die WebSocket-Verbindung nicht sauber geschlossen wurde (für einen sauberen Abschluss muss die zugehörige TCP-Verbindung nachdem der WebSocket-Schließungshandshake abgeschlossen ist, geschlossen werden).
Beispiele
const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);
wss.closed.then((result) => {
writeToScreen(
`DISCONNECTED: code ${result.closeCode}, message "${result.reason}"`,
);
console.log("Socket closed", result.closeCode, result.reason);
});
Ein vollständiges Beispiel mit ausführlicher Erklärung finden Sie unter Verwendung von WebSocketStream für die Erstellung eines Clients.
Spezifikationen
Derzeit nicht Teil einer Spezifikation. Siehe https://github.com/whatwg/websockets/pull/48 für den Fortschritt der Standardisierung.
Browser-Kompatibilität
Siehe auch
- WebSocketStream: Integration von Streams mit der WebSocket-API, developer.chrome.com (2020)