WebSocket: close()-Methode

Die WebSocket.close()-Methode schließt die WebSocket-Verbindung oder einen Verbindungsversuch, falls vorhanden. Wenn die Verbindung bereits CLOSED ist, tut diese Methode nichts.

Syntax

close()
close(code)
close(code, reason)

Parameter

code Optional

Ein ganzzahliger WebSocket-Verbindungsschlusscode der einen Grund für die Schließung angibt:

• Falls nicht angegeben, wird automatisch ein Schlusscode für die Verbindung festgelegt: 1000 für eine normale Schließung oder ansonsten ein anderer Standardwert im Bereich 1001-1015, der den tatsächlichen Grund für die Schließung der Verbindung angibt.
• Wenn angegeben, überschreibt der Wert dieses code-Parameters die automatische Festlegung des Schlusscodes für die Verbindung und legt stattdessen einen benutzerdefinierten Code fest. Der Wert muss eine Ganzzahl sein: entweder 1000 oder ein benutzerdefinierter Code Ihrer Wahl im Bereich 3000-4999. Wenn Sie einen code-Wert angeben, sollten Sie auch einen reason-Wert angeben.

reason Optional

Ein String, der einen benutzerdefinierten WebSocket-Verbindungsschließungsgrund (eine prägnante, für Menschen lesbare Erklärung der Schließung) angibt. Der Wert darf nicht länger als 123 Bytes (in UTF-8 kodiert) sein.

Hinweis: Da UTF-8 zwei bis vier Bytes verwendet, um nicht-ASCII-Zeichen zu kodieren, würde ein reason-Wert von 123 Zeichen, der nicht-ASCII-Zeichen enthält, das Limit von 123 Bytes überschreiten.

Wenn Sie einen reason-Wert angeben, sollten Sie auch einen code-Wert angeben.

Rückgabewert

Keiner (undefined).

Ausnahmen

InvalidAccessError DOMException

Wird ausgelöst, wenn code weder eine Ganzzahl gleich 1000 noch eine Ganzzahl im Bereich 3000 – 4999 ist.

SyntaxError DOMException

Wird ausgelöst, wenn der UTF-8-kodierte reason-Wert länger als 123 Bytes ist.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• RFC 6455 (die WebSocket-Protokollspezifikation)