SocketTask.close
基础库 1.0.0 开始支持本方法，这是一个异步方法。
关闭 WebSocket 连接的方法。
语法
SocketTask.close(options)参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| code | number | 1000 | 否 | 关闭连接状态码 | 1.0.0 |
| reason | string | -- | 否 | 连接被关闭的原因 | 1.0.0 |
| success | function | -- | 否 | 接口调用成功的回调函数 | 1.0.0 |
| fail | function | -- | 否 | 接口调用失败的回调函数 | 1.0.0 |
| complete | function | -- | 否 | 接口调用结束的回调函数（成功、失败都会执行） | 1.0.0 |
code 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| 1000 | 正常关闭 | 1.0.0 |
| 1001 | 由于处于后台等异常原因导致的关闭 | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | 回调信息 | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | 回调信息 | 1.0.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(() => {
console.log("WebSocket 已断开");
});
},
closeSocket() {
// 主动关闭 websocket 连接
if (socketTask) {
socketTask.close({
code: 1001,
reason: "close",
success: (res) => {
// 关闭成功的回调
console.log("close success", res);
},
fail: (res) => {
// 关闭失败的回调
console.log("close fail", res);
},
});
}
},
});Bug & Tip
- Tip：WebSocket 服务器接口地址必须是
wss协议，且域名必须是后台配置的合法域名。请参考网络请求。
点击纠错
该文档是否对你的开发有所帮助？
有帮助
没帮助
该文档是否对你的开发有所帮助？
有帮助
没帮助