创建一个 WebSocket 连接。使用前请注意阅读相关说明。
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| url | String | 是 | 开发者服务器 wss 接口地址 | |
| header | Object | 否 | HTTP Header，Header 中不能设置 Referer | |
| protocols | Array | 否 | 子协议数组 | |
| success | Function | 否 | 接口调用成功的回调函数 | |
| fail | Function | 否 | 接口调用失败的回调函数 | |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
qg.connectSocket({
url: "wss://example.qq.com",
header: {
"content-type": "application/json"
}
});
WebSocket 任务
通过 WebSocket 连接发送数据
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | 需要发送的内容 | |
| success | Function | 否 | 接口调用成功的回调函数 | |
| fail | Function | 否 | 接口调用失败的回调函数 | |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
关闭 WebSocket 连接
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| code | Number | 1000（表示正常关闭连接） | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |
| reason | String | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 | |
| success | Function | 否 | 接口调用成功的回调函数 | |
| fail | Function | 否 | 接口调用失败的回调函数 | |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
监听 WebSocket 连接打开事件
WebSocket 连接打开事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| header | object | 连接成功的 HTTP 响应 Header |
监听 WebSocket 接收到服务器的消息事件
WebSocket 接收到服务器的消息事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| data | String/ArrayBuffer | 服务器返回的消息 |
监听 WebSocket 连接关闭事件
WebSocket 连接关闭事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| code | Number | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |
| reason | String | 一个可读的字符串，表示连接被关闭的原因。 |
监听 WebSocket 错误事件
WebSocket 错误事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| errMsg | String | 错误信息 |