SocketTask
解释:WebSocket 任务,可通过 swan.connectSocket() 接口创建返回。
方法
1、 SocketTask.send
通过 WebSocket 连接发送数据。
Object参数说明:
属性名 | 类型 | 是否必须 | 说明 |
---|---|---|---|
data | String/ArrayBuffer | 是 | 需要发送的内容 |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
2、 SocketTask.close
Object参数说明:
属性名 | 类型 | 是否必须 | 说明 |
---|---|---|---|
code | Number | 否 | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭) |
reason | String | 否 | 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的 UTF-8 文本(不是字符) |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
3、 SocketTask.onOpen
监听 WebSocket 连接打开事件。
4、 SocketTask.onClose
监听 WebSocket 连接关闭事件。
5、 SocketTask.onError
监听 WebSocket 错误。
6、 SocketTask.onMessage
监听 WebSocket 接受到服务器的消息事件。
callback 回调结果说明:
属性名 | 类型 | 说明 |
---|---|---|
data | String/ArrayBuffer | 服务器返回的消息 |