WebSocket: close-Ereignis
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Juli 2015 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Das close-Ereignis wird ausgelöst, wenn eine Verbindung mit einem WebSocket geschlossen wird.
Syntax
Verwenden Sie den Ereignisnamen in addEventListener():
addEventListener("close", (event) => { })
Alternativ können Sie ihn der Event-Handler-Eigenschaft der Schnittstelle zuweisen:
onclose = (event) => { }
Ereignistyp
Ein CloseEvent. Erbt von Event.
Beispiele
Wenn die Verbindung geschlossen wurde, möchten Sie möglicherweise die Benutzeroberfläche aktualisieren oder Daten über die geschlossene Verbindung speichern. Angenommen, Sie haben eine Variable namens exampleSocket, die auf einen geöffneten WebSocket verweist. Dieser Handler behandelt den Fall, dass der Socket geschlossen wurde.
exampleSocket.addEventListener("close", (event) => {
console.log("The connection has been closed successfully.");
});
Sie können dieselben Aktionen auch über die Event-Handler-Eigenschaft ausführen (beachten Sie jedoch, dass dadurch gegebenenfalls andere mit onclose hinzugefügte Ereignis-Listener ersetzt werden):
exampleSocket.onclose = (event) => {
console.log("The connection has been closed successfully.");
};
Spezifikationen
| Spezifikation |
|---|
| WebSockets # dom-websocket-onclose |