WebSocket: close Ereignis
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Hinweis: Dieses Feature ist verfügbar in Web Workers.
Das close
Ereignis wird ausgelöst, wenn eine Verbindung mit einem WebSocket
geschlossen wird.
Syntax
Verwenden Sie den Ereignisnamen in Methoden wie addEventListener()
, oder setzen Sie eine Ereignis-Handler-Eigenschaft.
addEventListener("close", (event) => {});
onclose = (event) => {};
Ereignistyp
Ein CloseEvent
. Erbt von Event
.
Ereigniseigenschaften
Zusätzlich zu den unten aufgeführten Eigenschaften sind auch Eigenschaften von der übergeordneten Schnittstelle, Event
, verfügbar.
code
Nur lesbar-
Gibt einen
unsigned short
zurück, der den vom Server gesendeten Code enthält. reason
Nur lesbar-
Gibt einen String zurück, der den Grund angibt, warum der Server die Verbindung geschlossen hat. Dies ist spezifisch für den jeweiligen Server und das Sub-Protokoll.
wasClean
Nur lesbar-
Gibt einen booleschen Wert zurück, der anzeigt, ob die Verbindung sauber geschlossen wurde oder nicht.
Beispiele
Es könnte nützlich sein zu wissen, wann die Verbindung geschlossen wurde, um die Benutzeroberfläche zu aktualisieren oder möglicherweise Daten über die geschlossene Verbindung zu speichern. Angenommen, Sie haben eine Variable namens exampleSocket
, die auf einen geöffneten WebSocket
verweist, würde dieser Handler die Situation behandeln, in der der Socket geschlossen wurde.
exampleSocket.addEventListener("close", (event) => {
console.log("The connection has been closed successfully.");
});
Die gleichen Aktionen können Sie auch über die Ereignis-Handler-Eigenschaft ausführen, wie folgt:
exampleSocket.onclose = (event) => {
console.log("The connection has been closed successfully.");
};
Spezifikationen
Specification |
---|
WebSockets Standard # dom-websocket-onclose |
Browser-Kompatibilität
BCD tables only load in the browser