mgtv.closeSocket(Object object)
信息
框架版本 0.4.15 开始支持。
关闭 WebSocket 连接。推荐使用 SocketTask 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 mgtv 前缀的方法可能会带来一些和预期不一致的情况。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
code | number | 1000(表示正常关闭连接) | 否 | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 |
reason | string | 否 | 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码
mgtv.connectSocket({
url: "test.php",
});
//注意这里有时序问题,
//如果 mgtv.connectSocket 还没回调 mgtv.onSocketOpen,而先调用 mgtv.closeSocket,那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 mgtv.closeSocket 才能关闭。
mgtv.onSocketOpen(function () {
mgtv.closeSocket();
});
mgtv.onSocketClose(function (res) {
console.log("WebSocket 已关闭!");
});