SocketTask wx.connectSocket(Object object)

本接口从基础库版本 1.9.6 起支持在小程序插件中使用

创建一个 WebSocket 连接。使用前请注意阅读相关说明

参数

Object object

属性类型默认值必填说明最低版本
urlstring开发者服务器 wss 接口地址
headerObjectHTTP Header,Header 中不能设置 Referer
protocolsArray.<string>子协议数组1.4.0
tcpNoDelaybooleanfalse建立 TCP 连接的时候的 TCP_NODELAY 设置2.4.0
perMessageDeflatebooleanfalse是否开启压缩扩展2.8.0
timeoutnumber超时时间,单位为毫秒2.10.0
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

返回值

SocketTask

基础库 1.7.0 开始支持,低版本需做兼容处理

WebSocket 任务

并发数

  • 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接。
  • 1.7.0 以下版本,一个小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。

示例代码

  1. wx.connectSocket({
  2. url: 'wss://example.qq.com',
  3. header:{
  4. 'content-type': 'application/json'
  5. },
  6. protocols: ['protocol1']
  7. })