开发
API

SocketTask.onClose

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

监听 WebSocket 与服务器连接断开的事件。

语法

SocketTask.onClose(callback)

参数说明

参数为回调函数:

参数参数类型说明最低支持版本
callbackFunction连接成功的事件回调1.0.0

回调函数的参数为 object 类型,属性如下:

参数参数类型说明最低支持版本
protocolTypestring使用的网络传输层协议1.0.0
socketTypestringwebsocket 类型1.0.0
errMsgstring错误信息1.0.0
reasonstring关闭原因1.81.0
codestring关闭 code1.81.0

返回值

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<!-- index.ttml -->
<view>
  <button size="default" bindtap="socketConnect">创建 WebSocket</button>
  <button size="default" bindtap="closeSocket">关闭 WebSocket</button>
  <view></view
></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

  • Tip:WebSocket 服务器接口地址必须是 wss 协议,且域名必须是后台配置的合法域名。请参考网络请求使用说明
  • Bug: IDE 目前你没有返回 protocolTypesocketType 字段
点击纠错
评价此篇文档