websocket error code&n…

CloseEvent 会在连接关闭时发送给使用 WebSockets 的客户端. 它在 WebSocket 对象的 onclose 事件监听器中使用.

构造器EDIT

CloseEvent()

创建一个  CloseEvent.

属性EDIT

该接口也继承了其父类 Event 的属性.

CloseEvent.code  只读

返回一个 unsigned short 类型的数字, 表示服务端发送的关闭码, 以下为已分配的状态码.

状态码	名称	描述
0–999		保留段, 未使用.
1000	CLOSE_NORMAL	正常关闭; 无论为何目的而创建, 该链接都已成功完成任务.
1001	CLOSE_GOING_AWAY	终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开.
1002	CLOSE_PROTOCOL_ERROR	由于协议错误而中断连接.
1003	CLOSE_UNSUPPORTED	由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据).
1004		保留. 其意义可能会在未来定义.
1005	CLOSE_NO_STATUS	保留.  表示没有收到预期的状态码.
1006	CLOSE_ABNORMAL	保留. 用于期望收到状态码时连接非正常关闭 (也就是说, 没有发送关闭帧).
1007	Unsupported Data	由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据).
1008	Policy Violation	由于收到不符合约定的数据而断开连接. 这是一个通用状态码, 用于不适合使用 1003 和 1009 状态码的场景.
1009	CLOSE_TOO_LARGE	由于收到过大的数据帧而断开连接.
1010	Missing Extension	客户端期望服务器商定一个或多个拓展, 但服务器没有处理, 因此客户端断开连接.
1011	Internal Error	客户端由于遇到没有预料的情况阻止其完成请求, 因此服务端断开连接.
1012	Service Restart	服务器由于重启而断开连接. [Ref]
1013	Try Again Later	服务器由于临时原因断开连接, 如服务器过载因此断开一部分客户端连接. [Ref]
1014		由 WebSocket 标准保留以便未来使用.
1015	TLS Handshake	保留. 表示连接由于无法完成 TLS 握手而关闭 (例如无法验证服务器证书).
1016–1999		由 WebSocket 标准保留以便未来使用.
2000–2999		由 WebSocket 拓展保留使用.
3000–3999		可以由库或框架使用. 不应由应用使用. 可以在 IANA 注册, 先到先得.
4000–4999		可以由应用使用.

CloseEvent.reason  只读

返回一个  DOMString 用以表示服务器关闭连接的原因. 这是由服务器和子协议决定的.

CloseEvent.wasClean  只读

返回一个  Boolean 用以表示连接是否完全关闭.

MethodsEDIT

该接口也继承了其父类 Event 的属性.

CloseEvent.initCloseEvent()  

初始化创建的  CloseEvent 的值. 如果该事件已经被处理, 这个方法什么也不做. 不要直接使用这个方法, 使用  CloseEvent() 构造器来代替.

浏览器兼容性EDIT

 

• Desktop
•  
• Mobile

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari
Basic support	?	8.0 (8.0)[1] 12.0 (12.0)[2]	10	?	?
initCloseEvent()	未实现	8.0 (8.0) 未实现 41.0	未实现	未实现	未实现

 

[1] Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5) 以前, Gecko 简单地发送 close 事件给 WebSocket 监听器. 对 CloseEvent 的支持是在 Gecko 8.0 实现的.

[2] Gecko 12.0 (Firefox 12.0 / Thunderbird 12.0 / SeaMonkey 2.9) 以前, Gecko 当通道由于未知错误关闭, 或是错误原因不在标准之内时会上报 CLOSE_NORMAL 状态码. 现在则使用 CLOSE_GOING_AWAY 代替.

=================English=====我是和谐的分割线==========================

A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.

ConstructorEDIT

CloseEvent()

Creates a new  CloseEvent.

PropertiesEDIT

This interface also inherits properties from its parent, Event.

CloseEvent.code  Read only

Returns an  unsigned short containing the close code send by the server. The following values are permitted status codes.

Status code	Name	Description
0–999		Reserved and not used.
1000	CLOSE_NORMAL	Normal closure; the connection successfully completed whatever purpose for which it was created.
1001	CLOSE_GOING_AWAY	The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.
1002	CLOSE_PROTOCOL_ERROR	The endpoint is terminating the connection due to a protocol error.
1003	CLOSE_UNSUPPORTED	The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).
1004		Reserved. A meaning might be defined in the future.
1005	CLOSE_NO_STATUS	Reserved.  Indicates that no status code was provided even though one was expected.
1006	CLOSE_ABNORMAL	Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.
1007	Unsupported Data	The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).
1008	Policy Violation	The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.
1009	CLOSE_TOO_LARGE	The endpoint is terminating the connection because a data frame was received that is too large.
1010	Missing Extension	The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.
1011	Internal Error	The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
1012	Service Restart	The server is terminating the connection because it is restarting. [Ref]
1013	Try Again Later	The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients. [Ref]
1014		Reserved for future use by the WebSocket standard.
1015	TLS Handshake	Reserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
1016–1999		Reserved for future use by the WebSocket standard.
2000–2999		Reserved for use by WebSocket extensions.
3000–3999		Available for use by libraries and frameworks. May not be used by applications. Available for registration at the IANA via first-come, first-serve.
4000–4999		Available for use by applications.

CloseEvent.reason  Read only

Returns a  DOMString indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.

CloseEvent.wasClean  Read only

Returns a  Boolean that Indicates whether or not the connection was cleanly closed.

MethodsEDIT

This interface also inherits methods from its parent, Event.

CloseEvent.initCloseEvent()  

Initializes the value of a  CloseEvent created. If the event has already being dispatched, this method does nothing. Do not use this method anymore, use the  CloseEvent() constructor instead.

Browser compatibilityEDIT

 

• Desktop
•  
• Mobile

Feature	Chrome	Edge	Firefox (Gecko)	Internet Explorer	Opera	Safari
Basic support	?	(Yes)	8.0 (8.0)[1] 12.0 (12.0)[2]	10	?	?
initCloseEvent()	No support	(Yes)	8.0 (8.0) No support 41.0	No support	No support	No support

 

[1] Prior to Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5), Gecko sent the WebSocket closeevent to the listener as a simple event. Support for CloseEvent was implemented in Gecko 8.0.

[2] Prior to Gecko 12.0 (Firefox 12.0 / Thunderbird 12.0 / SeaMonkey 2.9), Gecko reported the close code CLOSE_NORMAL when the channel was closed due to an unexpected error, or if it was closed due to an error condition that the specification doesn't cover. Now CLOSE_GOING_AWAY is reported instead.