From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- files/zh-cn/web/api/closeevent/index.html | 238 ++++++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 files/zh-cn/web/api/closeevent/index.html (limited to 'files/zh-cn/web/api/closeevent') diff --git a/files/zh-cn/web/api/closeevent/index.html b/files/zh-cn/web/api/closeevent/index.html new file mode 100644 index 0000000000..1c9341ce1e --- /dev/null +++ b/files/zh-cn/web/api/closeevent/index.html @@ -0,0 +1,238 @@ +--- +title: CloseEvent +slug: Web/API/CloseEvent +tags: + - API + - Interface + - Reference + - Web + - WebSocket + - WebSockets +translation_of: Web/API/CloseEvent +--- +

{{APIRef("Websockets API")}}

+ +

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

+ +

构造器

+ +
+
{{domxref("CloseEvent.CloseEvent", "CloseEvent()")}}
+
创建一个 CloseEvent.
+
+ +

属性

+ +

该接口也继承了其父类 {{domxref("Event")}} 的属性.

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

Methods

+ +

该接口也继承了其父类 {{domxref("Event")}} 的属性.

+ +
+
{{domxref("CloseEvent.initCloseEvent()")}} {{Non-standard_inline}} {{Obsolete_inline}}
+
初始化创建的 CloseEvent 的值. 如果该事件已经被处理, 这个方法什么也不做. 不要直接使用这个方法, 使用 {{domxref("CloseEvent.CloseEvent", "CloseEvent()")}} ?构造器来代替.
+
+ +

浏览器兼容性

+ +

{{CompatibilityTable}}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureChromeFirefox (Gecko)Internet ExplorerOperaSafari
Basic support{{CompatUnknown}}{{CompatGeckoDesktop("8.0")}}[1]
+ {{CompatGeckoDesktop("12.0")}}[2]		10{{CompatUnknown}}{{CompatUnknown}}
initCloseEvent() {{Non-standard_inline}}{{CompatNo}}{{CompatGeckoDesktop("8.0")}}
+ {{CompatNo}} 41.0		{{CompatNo}}{{CompatNo}}{{CompatNo}}
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAndroidFirefox Mobile (Gecko)IE MobileOpera MobileSafari Mobile
Basic support{{CompatUnknown}}{{CompatGeckoMobile("8.0")}}{{CompatUnknown}}{{CompatUnknown}}{{CompatUnknown}}
initCloseEvent() {{Non-standard_inline}}{{CompatNo}}{{CompatGeckoMobile("8.0")}}
+ {{CompatNo}} 41.0		{{CompatNo}}{{CompatNo}}{{CompatNo}}
+
+ +

[1] Gecko 8.0 {{geckoRelease("8.0")}} 以前, Gecko ?简单地发送 {{event("close")}} ?事件给 WebSocket ?监听器. ?对 CloseEvent ?的支持是在 Gecko 8.0 实现的.

+ +

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

+ +

参考

+ + -- cgit v1.2.3-54-g00ecf