大网数据广告活动
Web 标准与前端开发

CloseEvent

· 52CE 我爱测

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

Websockets API

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

构造器

  • CloseEvent.CloseEvent
    • : 创建一个 CloseEvent.

属性

该接口也继承了其父类 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

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

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

Methods

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

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

浏览器兼容性

参考

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。