WebSocket.close()
WebSocket.close()
メソッドは、WebSocket
の接続、もしくは接続試行(存在した場合)を閉じます。接続がすでに CLOSED
だった場合、このメソッドは何もしません。
構文
WebSocket.close();
引数
code
省略可- 接続が閉じられている理由を説明するためのステータスコードを示す数値を指定します。このパラメータを指定しない場合、デフォルト値として 1005 が指定されます。許可されている値については
CloseEvent
のステータスコードの一覧を参照してください。 reason
省略可- 接続が閉じられている理由を説明するための人間が読める文字列を指定します。この文字列は UTF-8 テキスト (文字ではありません) で 123 バイトを超えていけません。
投げられる例外
INVALID_ACCESS_ERR
- 無効な
code
が指定された場合 SYNTAX_ERR
reason
に指定した文字列が長すぎるか、ペアリングされていないサロゲートを含んでいる場合
注意: Gecko において、Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5) 以前は、このメソッドはいづれのパラメータもサポートしていませんでした。
仕様書
仕様書 | 状態 | 備考 |
---|---|---|
HTML Living Standard The definition of 'WebSocket.close()' in that specification. |
Living Standard | 初回定義 |
ブラウザの互換性
BCD tables only load in the browser