SocketTask
基础库版本 1.0.0 开始支持
通过tt.connectSocket得到的 WebSocket 任务
方法
SocketTask.send(object)
通过 WebSocket 连接发送数据
参数
Object object
名称 | 数据类型 | 属性 | 默认值 | 描述 |
---|---|---|---|---|
data | string / arraybuffer | required | 数据内容 | |
success | function | optional | 接口调用成功的回调函数 | |
fail | function | optional | 接口调用失败的回调函数 | |
complete | function | optional | 接口调用结束的回调函数(成功、失败都会执行) |
SocketTask.close(option)
关闭 Socket 连接。
参数
Object option
名称 | 数据类型 | 属性 | 默认值 | 描述 |
---|---|---|---|---|
code | number | optional | 1000 | 关闭连接状态码 |
reason | string | optional | 关闭连接消息 | |
success | function | optional | 接口调用成功的回调函数 | |
fail | function | optional | 接口调用失败的回调函数 | |
complete | function | optional | 接口调用结束的回调函数(成功、失败都会执行) |
SocketTask.onOpen(callback)
参数
Function callback
监听连接成功的事件回调。
SocketTask.onClose(callback)
参数
Function callback
监听连接关闭的事件回调。
SocketTask.onError(callback)
参数
Function callback
监听连接发生错误的事件回调。
SocketTask.onMessage(callback)
参数
Function callback
监听连接成功的事件回调。res.data表示返回的数据,其数据格式是string|arraybuffer。