tt.connectSocket
基础库版本 1.0.0 开始支持
创建一个 WebSocket 连接实例,并通过返回的socketTask操作该连接。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求使用说明
参数
名称 | 数据类型 | 属性 | 默认值 | 描述 |
---|---|---|---|---|
url | string | required | N/A | Socket 连接地址 |
header | object | optional | HTTP Header | |
protocols | Array[string] | optional | null
|
子协议数组 |
success | function | optional | 接口调用成功的回调函数 | |
fail | function | optional | 接口调用失败的回调函数 | |
complete | function | optional | 接口调用结束的回调函数(成功、失败都执行) |
返回值
SocketTask对象。
代码示例
let socketTask = tt.connectSocket({
url: "wss://somepath",
protocols: ["p1"]
});
socketTask.onOpen(() => {
console.log("WebSocket 已连接");
});
socketTask.onClose(() => {
console.log("WebSocket 已断开");
});
socketTask.onError(error => {
console.error("WebSocket 发生错误:", error);
});
socketTask.onMessage(message => {
console.log("socket message:", message);
let data = message.data;
if (Object.prototype.toString.call(data) === "[object ArrayBuffer]") {
data = Codec.read(data);
}
});