WebSocket: close Ereignis

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener(), oder setzen Sie eine Ereignishandler-Eigenschaft.

addEventListener("close", (event) => { })

onclose = (event) => { }

Ereignistyp

Ein CloseEvent. Erbt von Event.

Ereigniseigenschaften

Neben den unten aufgeführten Eigenschaften stehen Eigenschaften der Elternschnittstelle, Event, zur Verfügung.

code Schreibgeschützt

Gibt ein unsigned short zurück, das den vom Server gesendeten Schließungscode enthält.

reason Schreibgeschützt

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 Schreibgeschützt

Gibt einen booleschen Wert zurück, der angibt, ob die Verbindung sauber geschlossen wurde oder nicht.

Beispiele

Es könnte nützlich sein zu wissen, wann die Verbindung geschlossen wurde, damit Sie die Benutzeroberfläche aktualisieren oder eventuell Daten über die geschlossene Verbindung speichern können. Wenn Sie eine Variable namens exampleSocket haben, die sich auf einen geöffneten WebSocket bezieht, 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.");
});

Sie können die gleichen Aktionen mit der Ereignishandler-Eigenschaft ausführen, wie folgt:

exampleSocket.onclose = (event) => {
  console.log("The connection has been closed successfully.");
};

Spezifikationen

Browser-Kompatibilität

Siehe auch

• WebSocket: error Ereignis
• WebSocket: message Ereignis
• WebSocket: open Ereignis
• Schreiben von WebSocket-Client-Anwendungen