connectSocket
创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。
该 API 会同步返回 SocketTask,但连接创建本身是异步过程。调用方应先在返回的
SocketTask 上注册事件回调,再等待 onOpen 表示连接可用。后续发送消息使用
SocketTask.send,关闭连接使用 SocketTask.close。
扫码预览
支持版本
前端库版本不低于 0.0.30。
支持平台
支持场景
使用说明
-
返回
SocketTask不代表连接已经成功,连接成功以onOpen为准。 -
send必须接收对象参数,并把要发送的内容放在data字段中。 -
如果
protocols非空,需要服务端支持并返回匹配的子协议。 -
多次调用会创建多条连接,旧连接不会自动关闭;不再使用时应主动调用
close。 -
连接失败、发送失败或关闭失败会通过
SocketTask.onError通知。 -
不再使用的连接应主动调用 SocketTask.close 释放资源,避免占用连接名额。
调用方式
同步 API
入参
调用示例
返回值
返回示例
错误处理
同步调用失败时抛出错误。错误对象和通用错误码见 通用错误处理。
失败示例
错误码
通用错误码
平台差异
- Android:建立连接失败统一返回 102;send 在连接未打开时返回 305 或 116。
- iOS:send 在连接未打开时返回 1501002。
已知限制与注意事项
- 同一应用插件内最多同时保持 5 条 WebSocket 连接,超过上限时 connectSocket 会立即同步失败并通过 SocketTask.onError 通知。