我的书签
添加书签
移除书签WebSocket
qh.connectSocket
解释：创建一个 WebSocket 连接。
方法参数：Object object
object参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| url | String | 是 | - | 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名。 |
| protocols | StringArray | 否 | - | 子协议数组 |
| success | Function | 否 | - | 接口调用成功的回调函数 |
| fail | Function | 否 | - | 接口调用失败的回调函数 |
| complete | Function | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
qh.onSocketOpen
解释：监听 WebSocket 连接打开事件。
方法参数：Function callback
callback参数说明：WebSocket 连接打开事件的回调函数。
callback方法参数：Object res
res参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| header | Object | 是 | - | 连接成功的 HTTP 响应 Header。 |
qh.onSocketError
解释：监听 WebSocket 错误
方法参数：Function callback
qh.sendSocketMessage
解释：通过 WebSocket 连接发送数据，需要先调用 qh.connectSocket，并在 qh.onSocketOpen 回调之后才能发送。
方法参数：Object object
object参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | - | 需要发送的内容 |
| success | Function | 否 | - | 接口调用成功的回调函数 |
| fail | Function | 否 | - | 接口调用失败的回调函数 |
| complete | Function | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
qh.onSocketMessage
解释：监听 WebSocket 接受到服务器的消息事件
方法参数：Function callback
callback参数说明：WebSocket 接受到服务器的消息事件的回调函数
callback方法参数：Object res
res参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | - | 服务器返回的消息 |
qh.closeSocket
解释：关闭 WebSocket 连接。 必须在 WebSocket 打开期间调用 qh.closeSocket 才能关闭。
方法参数：Object object
object参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| code | Number | 否 | - | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |
| reason | String | 否 | - | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的 UTF-8 文本（不是字符） |
| success | Function | 否 | - | 接口调用成功的回调函数 |
| fail | Function | 否 | - | 接口调用失败的回调函数 |
| complete | Function | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
qh.onSocketClose
解释：监听 WebSocket 关闭。
方法参数：Function callback
SocketTask
解释：WebSocket 任务，可通过 qh.connectSocket() 接口创建返回。
SocketTask.send
解释：通过 WebSocket 连接发送数据。
方法参数：Object object
object参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | - | 需要发送的内容 |
| success | Function | 否 | - | 接口调用成功的回调函数 |
| fail | Function | 否 | - | 接口调用失败的回调函数 |
| complete | Function | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
SocketTask.close
解释：关闭 WebSocket 连接
方法参数：Object object
object参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| code | Number | 否 | 1000 （表示正常连接关闭） | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定。 |
| reason | String | 否 | - | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的 UTF-8 文本（不是字符） |
| success | Function | 否 | - | 接口调用成功的回调函数 |
| fail | Function | 否 | - | 接口调用失败的回调函数 |
| complete | Function | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
SocketTask.onOpen
解释：监听 WebSocket 连接打开事件。
方法参数：Function callback
SocketTask.onClose
解释：监听 WebSocket 连接关闭事件。
方法参数：Function callback
SocketTask.onError
解释：监听 WebSocket 错误。
方法参数：Function callback
SocketTask.onMessage
解释：监听 WebSocket 接受到服务器的消息事件。
方法参数：Function callback
callback参数说明：
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | - | 服务器返回的消息 |
