# connectSocket

调用 connectSocket(Object object) 创建一个 WebSocket 连接实例,并通过返回的 socketTask 操作该连接

注意

Socket 数量的最大限制为 5。

# 支持说明

应用能力 Android iOS PC 预览效果
小程序 3.19.0 3.19.0 3.21.0
扫码预览
用BoosHi扫码或PC端点击
网页应用 X X X /

# 输入

继承标准对象输入,扩展属性描述:

名称 数据类型 必填 默认值 描述
url string Socket 连接地址
示例值:wss://echo.websocket.org
header object 请求 Header
示例值:{'content-type': 'application/json'}
protocols string[] 子协议数组。
示例值:['protocol1']

# 输出

返回值 SocketTask,该对象的方法列表参见下表:

方法 介绍
send(Object msg) 发送数据。
close(Object option) 关闭 Socket 连接。
onOpen(function callback) 监听连接成功的事件回调。
onClose(function callback) 监听连接关闭的事件回调。
onMessage(function callback) 监听接收到服务器的消息事件回调。

# 示例代码

let socketTask = bz.connectSocket({
    url: 'wss://echo.websocket.org',
    success() {
        console.log('Build WebSocketTask success');
    },
    fail(err) {
        console.error('Build WebSocketTask failed', err);
    }
});
1
2
3
4
5
6
7
8
9
最后更新于 : 3/8/2024, 2:14:46 PM