跳到主要内容

SocketTask mgtv.connectSocket(Object object)

信息

框架版本 0.4.15 开始支持。

创建一个 WebSocket 连接。使用前请注意阅读相关说明。推荐使用 SocketTask 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 mgtv 前缀的方法可能会带来一些和预期不一致的情况。

参数

Object object

属性类型默认值必填说明
urlstring开发者服务器 wss 接口地址
headerobjectHTTP Header,Header 中不能设置 Referrer
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

返回值

SocketTask

WebSocket 任务

示例代码

mgtv.connectSocket({
url: "wss://example.mgtv.com",
header: {
"content-type": "application/json",
},
protocols: ["protocol1"],
});