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 code-Eigenschaft des CloseEvent-Interfaces gibt einen WebSocket-Verbindungsschlusscode zurück, der den Grund angibt, warum die Verbindung geschlossen wurde.

Wert

Ein ganzzahliger WebSocket-Verbindungsschlusscode im Bereich 1000 - 4999, der den Grund angibt, warum die Verbindung geschlossen wurde.

Statuscode Bedeutung Beschreibung
0–999 Nicht verwendet.
1000 Normaler Abschluss Die Verbindung hat erfolgreich den Zweck erfüllt, für den sie erstellt wurde.
1001 Gehend Der Endpunkt wird geschlossen, entweder aufgrund eines Serverfehlers oder weil der Browser von der Seite weg navigiert, die die Verbindung geöffnet hat.
1002 Protokollfehler Der Endpunkt beendet die Verbindung aufgrund eines Protokollfehlers.
1003 Nicht unterstützte Daten Die Verbindung wird beendet, weil der Endpunkt Daten eines Typs empfängt, den er nicht akzeptieren kann. (Zum Beispiel erhält ein nur-text-Endpunkt Binärdaten.)
1004 Reserviert Reserviert. Eine Bedeutung könnte in der Zukunft definiert werden.
1005 Kein Status erhalten Reserviert. Zeigt an, dass kein Statuscode angegeben wurde, obwohl einer erwartet wurde.
1006 Abnormaler Abschluss Reserviert. Zeigt an, dass eine Verbindung abnormal geschlossen wurde (d.h. ohne dass ein Abschluss-Frame gesendet wurde), wenn ein Statuscode erwartet wird.
1007 Ungültige Frame-Payload-Daten Der Endpunkt beendet die Verbindung, weil eine Nachricht empfangen wurde, die inkonsistente Daten enthält (z. B. nicht-UTF-8-Daten innerhalb einer Textnachricht).
1008 Richtlinienverstoß Der Endpunkt beendet die Verbindung, weil er eine Nachricht erhalten hat, die seine Richtlinie verletzt. Dies ist ein generischer Statuscode, der verwendet wird, wenn Codes 1003 und 1009 nicht geeignet sind.
1009 Nachricht zu groß Der Endpunkt beendet die Verbindung, weil ein Datenframe empfangen wurde, der zu groß ist.
1010 Erforderliche Erweiterung Der Client beendet die Verbindung, weil er erwartet hat, dass der Server eine oder mehrere Erweiterungen verhandelt, dies jedoch nicht getan hat.
1011 Interner Fehler Der Server beendet die Verbindung, weil er auf eine unerwartete Bedingung gestoßen ist, die ihn daran hindert, die Anfrage zu erfüllen.
1012 Dienstneustart Der Server beendet die Verbindung, weil er einen Neustart durchführt.
1013 Später erneut versuchen Der Server beendet die Verbindung aufgrund einer vorübergehenden Bedingung, z. B. weil er überlastet ist und einige seiner Clients abwirft.
1014 Schlechtes Gateway Der Server agierte als Gateway oder Proxy und erhielt eine ungültige Antwort vom Upstream-Server. Dies ist ähnlich dem HTTP-Statuscode 502.
1015 TLS-Handschlag Reserviert. Zeigt an, dass die Verbindung aufgrund eines Fehlers beim Herstellen eines TLS-Handschlags (z. B. kann das Serverzertifikat nicht verifiziert werden) geschlossen wurde.
1016–2999 Für die Definition durch zukünftige Revisionen der WebSocket-Protokollspezifikation und für die Definition durch Erweiterungsspezifikationen.
3000–3999 Für die Verwendung durch Bibliotheken, Frameworks und Anwendungen. Diese Statuscodes sind direkt bei IANA registriert. Die Interpretation dieser Codes ist im WebSocket-Protokoll nicht definiert.
4000–4999 Für private Nutzung, daher können sie nicht registriert werden. Solche Codes können durch vorherige Vereinbarungen zwischen WebSocket-Anwendungen verwendet werden. Die Interpretation dieser Codes ist im 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