From 7aeeaaa3e752e7ae74ff5d6cd4722467e70dbc83 Mon Sep 17 00:00:00 2001 From: wanganxp Date: Wed, 28 Aug 2019 06:36:54 +0800 Subject: [PATCH] Update websocket.md --- docs/api/request/websocket.md | 54 ++++------------------------------- 1 file changed, 5 insertions(+), 49 deletions(-) diff --git a/docs/api/request/websocket.md b/docs/api/request/websocket.md index 5bc8a0b23..dd50f5f0a 100644 --- a/docs/api/request/websocket.md +++ b/docs/api/request/websocket.md @@ -47,29 +47,15 @@ var socketTask = uni.connectSocket({ 如果没有传入 success / fail / complete 参数,则会返回封装后的 Promise 对象:[Promise 封装](/api/README?id=promise-%E5%B0%81%E8%A3%85) -**注意事项** - -- 网络请求的 ``超时时间`` 可以统一在 ``manifest.json`` 中配置 [networkTimeout](/collocation/manifest?id=networktimeout)。 -- 目前不支持 ``ArrayBuffer`` 类型的数据收发,可以使用 [plus-websocket](http://ext.dcloud.net.cn/plugin?id=647) 插件替代。 -- 自定义组件模式下是基于 `weex` 的 `v8` 引擎运行,所有 `vue` 页面的 `js` 都是在同一个 `weex` 的 `js` 环境中运行。目前 `weex` 限制一个 `js` 环境中只支持一个 `websocket` 连接,所以导致所有 `vue` 页面只能使用一个 `websocket` 连接。 - -**临时解决方案:** - - - 回退使用非自定义组件模式(不推荐) - - 多个 websocket 在独立的 nvue 页面中使用 - - 使用 [plus-websocket](http://ext.dcloud.net.cn/plugin?id=647) 插件替代 - -后续我们会修改 `weex` 的限制,以支持多个 `websocket` 连接 +**注意事项** + +- 网络请求的 ``超时时间`` 可以统一在 ``manifest.json`` 中配置 [networkTimeout](/collocation/manifest?id=networktimeout)。 +- App目前不支持 ``ArrayBuffer`` 类型的数据收发。可以使用 [plus-websocket](https://ext.dcloud.net.cn/plugin?id=647) 插件替代。 +- 自定义组件模式下所有 `vue` 页面只能使用一个 `websocket` 连接。可以使用 [plus-websocket](https://ext.dcloud.net.cn/plugin?id=647) 插件替代。 ### uni.onSocketOpen(CALLBACK) 监听WebSocket连接打开事件。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **CALLBACK 返回参数** |属性|类型|说明| @@ -91,12 +77,6 @@ uni.onSocketOpen(function (res) { ### uni.onSocketError(CALLBACK) 监听WebSocket错误。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **示例代码** ```javascript @@ -114,12 +94,6 @@ uni.onSocketError(function (res) { ### uni.sendSocketMessage(OBJECT) 通过 WebSocket 连接发送数据,需要先 [uni.connectSocket](/api/request/websocket?id=connectsocket),并在 [uni.onSocketOpen](/api/request/websocket?id=onsocketopen) 回调之后才能发送。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **OBJECT 参数说明:** |参数名|类型|必填|说明| @@ -161,12 +135,6 @@ function sendSocketMessage(msg) { ### uni.onSocketMessage(CALLBACK) 监听WebSocket接受到服务器的消息事件。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **CALLBACK 返回参数** |参数|类型|说明| @@ -188,12 +156,6 @@ uni.onSocketMessage(function (res) { ### uni.closeSocket(OBJECT) 关闭 WebSocket 连接。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **OBJECT 参数说明** |参数名|类型|必填|说明| @@ -207,12 +169,6 @@ uni.onSocketMessage(function (res) { ### uni.onSocketClose(CALLBACK) 监听WebSocket关闭。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - ```javascript uni.connectSocket({ url: 'wss://www.example.com/socket' -- GitLab