SocketTask.close

解释：关闭 WebSocket 连接

方法参数

Object object

object参数说明

属性名类型必填默认值说明
codeNumber否1000 （表示正常连接关闭）一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定。
reasonString否一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的 UTF-8 文本（不是字符）
successFunction否接口调用成功的回调函数
failFunction否接口调用失败的回调函数
completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

示例

扫码体验

SocketTask.close - 图1请使用百度APP扫码

图片示例

SocketTask.close - 图2

SocketTask.close - 图3

SocketTask.close - 图4

代码示例1

在开发者工具中预览效果

  • 在 js 文件中
  1. Page({
  2.     data: {
  3.         disabled: false
  4.     },
  5.     onTap() {
  6.         let that = this;
  7.         that.setData('disabled', true);
  8.         const socketTask = swan.connectSocket({
  9.             url: 'wss://echo.websocket.org',
  10.             header: {},
  11.             success: function (res) {
  12.                 console.log('connectSocket success', res.socketTaskId);
  13.             },
  14.             fail: function (err) {
  15.                 console.log('connectSocket fail', err);
  16.             }
  17.         });
  19.         socketTask.onOpen(function (res) {
  20.             that.socketTaskClose();
  21.         })
  22.         this.socketTask = socketTask;
  24.     },
  25.     socketTaskClose() {
  26.         let that = this;
  27.         this.socketTask.close({
  28.             success: res => {
  29.                 that.setData('disabled', false);
  30.                 console.log('关闭WebSocket成功', res);
  31.                 swan.showToast({
  32.                     title: '关闭WebSocket成功',
  33.                     icon: 'none'
  34.                 });
  35.             },
  36.             fail: err => {
  37.                 console.log('关闭WebSocket失败', err);
  38.             }
  39.         });
  40.     }
  41. });

代码示例2 - 参数全集

在开发者工具中预览效果

  • 在 js 文件中
  1. this.socketTask.close({
  2.     code: 1000,
  3.     reason: '正常关闭',
  4.     success: res => {
  5.         that.setData('disabled', false)
  6.         console.log('关闭WebSocket成功', res);
  7.         swan.showToast({
  8.             title: '关闭WebSocket成功',
  9.             icon: 'none'
  10.         });
  11.     },
  12.     fail: err => {
  13.         console.log('关闭WebSocket失败', err);
  14.     }
  15. });