CloseEvent: code Eigenschaft

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: Diese Funktion ist in Web Workers verfügbar.

Die schreibgeschützte Eigenschaft code des CloseEvent-Interfaces gibt einen WebSocket-Verbindungsabschlusscode zurück, der den Grund angibt, warum die Verbindung geschlossen wurde.

Wert

Ein ganzzahliger WebSocket-Verbindungsabschlusscode im Bereich von 1000 - 4999, der den Grund für die Schließung der Verbindung angibt.

Statuscode Bedeutung Beschreibung
0–999 Nicht verwendet.
1000 Normal Closure Die Verbindung hat den Zweck, für den sie erstellt wurde, erfolgreich abgeschlossen.
1001 Going Away Der Endpunkt wird beendet, entweder aufgrund eines Serverausfalls oder weil der Browser von der Seite, die die Verbindung geöffnet hat, weg navigiert.
1002 Protocol error Der Endpunkt beendet die Verbindung aufgrund eines Protokollfehlers.
1003 Unsupported Data Die Verbindung wird beendet, weil der Endpunkt Daten eines Typs erhalten hat, den er nicht akzeptieren kann. (Zum Beispiel hat ein nur-Text-Endpunkt Binärdaten erhalten.)
1004 Reserviert Reserviert. Eine Bedeutung könnte in der Zukunft definiert werden.
1005 No Status Rcvd Reserviert. Bedeutet, dass kein Statuscode angegeben wurde, obwohl einer erwartet wurde.
1006 Abnormal Closure Reserviert. Bedeutet, dass eine Verbindung auf anormale Weise geschlossen wurde (das heißt, ohne dass ein Abschlussframe gesendet wurde), obwohl ein Statuscode erwartet wird.
1007 Invalid frame payload data Der Endpunkt beendet die Verbindung, da eine Nachricht mit inkonsistenten Daten empfangen wurde (z.B., nicht-UTF-8-Daten innerhalb einer Textnachricht).
1008 Policy Violation Der Endpunkt beendet die Verbindung, weil er eine Nachricht empfangen hat, die gegen seine Richtlinien verstößt. Dies ist ein generischer Statuscode, der verwendet wird, wenn die Codes 1003 und 1009 nicht geeignet sind.
1009 Message Too Big Der Endpunkt beendet die Verbindung, weil ein Datenrahmen empfangen wurde, der zu groß ist.
1010 Mandatory Ext. Der Client beendet die Verbindung, weil er erwartete, dass der Server eine oder mehrere Erweiterungen verhandelt, dies aber nicht tat.
1011 Internal Error Der Server beendet die Verbindung, weil er auf eine unerwartete Bedingung gestoßen ist, die ihn daran hinderte, die Anfrage zu erfüllen.
1012 Service Restart Der Server beendet die Verbindung, weil er neu startet.
1013 Try Again Later Der Server beendet die Verbindung aufgrund einer vorübergehenden Bedingung, z.B., er ist überlastet und gibt einige seiner Clients auf.
1014 Bad Gateway Der Server handelte als Gateway oder Proxy und erhielt eine ungültige Antwort vom Upstream-Server. Dies ist ähnlich wie der HTTP-Statuscode 502.
1015 TLS handshake Reserviert. Bedeutet, dass die Verbindung aufgrund eines Fehlers beim TLS-Handshake geschlossen wurde (z.B. das Serverzertifikat kann nicht verifiziert werden).
1016–2999 Zur Definition durch zukünftige Überarbeitungen der WebSocket-Protokollspezifikation und zur Definition durch Erweiterungsspezifikationen.
3000–3999 Zur Verwendung durch Bibliotheken, Frameworks und Anwendungen. Diese Statuscodes sind direkt bei der IANA registriert. Die Interpretation dieser Codes ist durch das WebSocket-Protokoll nicht definiert.
4000–4999 Für private Nutzung und daher nicht registrierbar. Solche Codes können durch vorherige Vereinbarungen zwischen WebSocket-Anwendungen verwendet werden. Die Interpretation dieser Codes ist durch das WebSocket-Protokoll nicht definiert.

Beispiele

Das folgende Beispiel gibt den Wert von code in der Konsole aus.

js
WebSocket.onclose = (event) => {
  console.log(event.code);
};

Spezifikationen

Specification
WebSockets
# ref-for-dom-closeevent-code②

Browser-Kompatibilität

Siehe auch