Skip to content

WebSocket ​

支持标准的 WebSocket 功能。 在此基础上,扩展了 WebSocket 的构造函数,具体见下面

js
    WebSocket WebSocket(url, protocols, caFilePath, extensions)

构造函数返回一个 WebSocket 对象

参数

  • string url: 要连接的 URL; 这应该是 WebSocket 服务器将响应的 URL

  • string | Array<string> protocols: [可选] 一个协议字符串或者一个包含协议字符串的数组。 这些字符串用于指定子协议,这样单个服务器可以实现多个 WebSocket 子协议(例如,您可能希望一台服务器能够根据指定的协议(protocol)处理不同类型的交互)。如果没有指定协议字符串,则为空字符串

  • string caFilePath: [可选] 配置 wss 支持的自定义证书路径

  • Object extensions: [可选] 扩展数据,具体说明见下图

extensions 的属性说明:

属性键值类型是否必填说明
headerObject否HTTP Header,Header 中不能设置 Referer, 默认为 {}
tcpNoDelayboolean否建立 TCP 连接的时候的 TCP_NODELAY 设置,默认为 false
perMessageDeflateboolean否是否开启压缩扩展,默认为 false
timeoutnumber否超时时间,单位为毫秒,默认为 60000

返回值

  • WebSocket: 返回一个 WebSocket 对象。