CloseEvent: code Eigenschaft
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.
Die code schreibgeschützte 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 den Zweck, für den sie erstellt wurde, erfolgreich abgeschlossen. |
1001 |
Verschwindet | Der Endpunkt verschwindet, entweder aufgrund eines Serverfehlers oder weil der Browser die Seite verlässt, 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 empfangen hat, den er nicht akzeptieren kann. (Zum Beispiel hat ein nur-Text-Endpunkt Binärdaten empfangen.) |
1004 |
Reserviert | Reserviert. Eine Bedeutung könnte in Zukunft definiert werden. |
1005 |
Kein Status empfangen | Reserviert. Gibt an, dass kein Statuscode bereitgestellt wurde, obwohl einer erwartet wurde. |
1006 |
Anormaler Abschluss | Reserviert. Gibt an, dass eine Verbindung anormal geschlossen wurde (d.h. ohne dass ein Schluss-Frame gesendet wird), wenn ein Statuscode erwartet wird. |
1007 |
Ungültige Frame-Payload-Daten | Der Endpunkt beendet die Verbindung, da eine Nachricht empfangen wurde, die inkonsistente Daten enthält (z.B. nicht-UTF-8-Daten in einer Textnachricht). |
1008 |
Richtlinienverstoß | Der Endpunkt beendet die Verbindung, weil er eine Nachricht erhalten 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 |
Nachricht zu groß | Der Endpunkt beendet die Verbindung, da ein Daten-Frame empfangen wurde, das zu groß ist. |
1010 |
Verpflichtende Erweiterung | Der Client beendet die Verbindung, weil er erwartete, dass der Server eine oder mehrere Erweiterungen verhandelt, dies jedoch nicht tat. |
1011 |
Interner Fehler | Der Server beendet die Verbindung, weil er eine unerwartete Bedingung angetroffen hat, die ihn daran gehindert hat, die Anfrage zu erfüllen. |
1012 |
Dienst-Neustart | Der Server beendet die Verbindung, weil er neu startet. |
1013 |
Versuchen Sie es später erneut | Der Server beendet die Verbindung aufgrund einer temporären Bedingung, z.B. ist er überlastet und trennt einige seiner Clients. |
1014 |
Schlechtes Gateway | Der Server fungierte 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. Gibt an, dass die Verbindung aufgrund eines Fehlers beim Ausführen eines TLS-Handshakes geschlossen wurde (z.B. kann das Serverzertifikat nicht verifiziert werden). |
1016–2999 |
Zur Definition durch zukünftige Revisionen der WebSocket-Protokollspezifikation und zur Definition durch Erweiterungsspezifikationen. | |
3000–3999 |
Zur Nutzung durch Bibliotheken, Frameworks und Anwendungen. Diese Statuscodes sind direkt bei IANA registriert. Die Interpretation dieser Codes ist durch das WebSocket-Protokoll nicht definiert. | |
4000–4999 |
Zur privaten Nutzung und können daher nicht registriert werden. 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 druckt den Wert von code in die Konsole.
js
WebSocket.onclose = (event) => {
console.log(event.code);
};
Spezifikationen
| Spezifikation |
|---|
| WebSockets # ref-for-dom-closeevent-code② |
Browser-Kompatibilität
Siehe auch
- RFC 6455 (Die WebSocket-Protokollspezifikation)
- WebSocket Close Code Number Registry (IANA)