WebSocket.close()

WebSocket.close() 方法关闭 WebSocket  连接或连接尝试(如果有的话)。 如果连接已经关闭,则此方法不执行任何操作。

语法

WebSocket.close();

参数

code 可选
一个数字状态码,它解释了连接关闭的原因。如果没有传这个参数,默认使用 1005。CloseEvent的允许的状态码见状态码列表
reason 可选
一个人类可读的字符串,它解释了连接关闭的原因。这个 UTF-8 编码的字符串不能超过 123 个字节。

抛出的异常

INVALID_ACCESS_ERR
一个无效的code
SYNTAX_ERR
reason 字符串太长(超过 123 字节)

注意: 在 Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5)之前版本的 Gecko 里,这个方法不支持传参数。

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'WebSocket.close()' in that specification.
Living Standard Initial definition

Browser compatibility

BCD tables only load in the browser