SocketTask.onClose
基础库 1.0.0 开始支持本方法,这是一个同步方法。
监听 WebSocket 与服务器连接断开的事件。
语法
SocketTask.onClose(callback)
参数说明
callback
类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|
function | 是 | 连接断开的事件回调 | 1.0.0 |
回调函数参数说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
protocolType | string | 使用的网络传输层协议 | 1.0.0 |
socketType | string | websocket 类型 | 1.0.0 |
errMsg | string | 错误信息 | 1.0.0 |
reason | string | 关闭原因 | 1.81.0 |
code | string | 关闭 code | 1.81.0 |
返回值
无
扫码体验
请使用字节宿主APP扫码
代码示例
<!-- index.ttml -->
<view>
<button size="default" bindtap="socketConnect">创建 WebSocket</button>
<button size="default" bindtap="closeSocket">关闭 WebSocket</button>
</view>
let socketTask;
Page({
socketConnect() {
socketTask = tt.connectSocket({
url: "wss://someurl",
success: (res) => {
console.log("创建成功", res);
},
fail: (res) => {
console.log("创建失败", res);
},
});
socketTask.onClose((res) => {
// WebSocket连接已经断开
console.log("WebSocket 已断开", res);
});
},
closeSocket() {
// 关闭 websocket 连接
if (socketTask) {
socketTask.close();
}
},
});
Bug & Tip
- Bug: IDE 目前没有返回
protocolType
和socketType
字段; - Tip:WebSocket 服务器接口地址必须是
wss
协议,且域名必须是后台配置的合法域名。请参考网络请求。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助