普通小游戏开发
开放能力(必读)
社交转发裂变
数据分析
视频拍摄器
API
多端支持

SocketTask.close

基础库 1.0.0 开始支持本方法。

关闭 WebSocket 连接的方法。

语法

SocketTask.close(options)

参数说明

options 为 Object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
codenumber1000/1001关闭连接状态码1.0.0
reasonstring--连接被关闭的原因1.0.0
successfunction--接口调用成功的回调函数1.0.0
failfunction--接口调用失败的回调函数1.0.0
completefunction--接口调用结束的回调函数(成功、失败都会执行)1.0.0

code 值说明:

code 值说明
1000正常关闭
1001由于处于后台等异常原因导致的关闭

回调成功

Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.0.0

回调失败

Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.0.0

代码示例

开发者工具中预览

const socketTask = tt.connectSocket({
  url: "wss://someurl",
  success: (res) => {
    console.log("创建成功", res);
  },
  fail: (res) => {
    console.log("创建失败", res);
  },
});

socketTask.onClose(() => {
  console.log("WebSocket 已断开");
});

setTimeout(() => {
  socketTask.close({
    code: 1001,
    reason: "close",
    success: (res) => {
      // 关闭成功的回调
      console.log("close success", res);
    },
    fail: (res) => {
      // 关闭失败的回调
      console.log("close fail", res);
    },
  });
}, 1000);

Bug & Tip

  • Tip:WebSocket 服务器接口地址必须是 wss 协议,且域名必须是后台配置的合法域名。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助