WebSocketStream: closed-Eigenschaft
Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.
Hinweis: Dieses Feature ist verfügbar in Web Workers.
Die closed
schreibgeschützte Eigenschaft 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ßcode 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ßcode 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 ein sauberes Schließen muss die zugehörige TCP-Verbindung nachdem der WebSocket-Schließhandshake 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);
});
Siehe Verwendung von WebSocketStream, um einen Client zu schreiben für ein vollständiges Beispiel mit ausführlicher Erklärung.
Spezifikationen
Derzeit nicht Teil einer Spezifikation. Siehe https://github.com/whatwg/websockets/pull/48 für den Stand der Standardisierung.
Browser-Kompatibilität
BCD tables only load in the browser
Siehe auch
- WebSocketStream: Integration von Streams mit der WebSocket API, developer.chrome.com (2020)