• JS API 列表
  • 基础
  • TTML
  • 网络
  • 网络 JS API 调用说明
  • 小程序 Cookie 机制
  • HTTP
  • WebSocket
  • tt.connectSocket
  • SocketTask
  • EventSource
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • tt.connectSocket
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。

    创建一个 WebSocket 连接实例,并通过返回的socketTask操作该连接。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求

    前提条件
    业务背景
    使用限制
    注意事项
    • Tip: 最多可以同时存在 5 个 WebSocket 连接;
    • Tip:header 不支持设置 referer 字段;
    • Tip:在当前小程序页面已经有一个WebSocket 连接的情况下,如果再创建一个WebSocket 连接,会重新创建一个 WebSocket 连接,但是之前创建的WebSocket 连接并不会自动关闭;
    • Tip:在使用 send 方法时,参数必须是 object 类型,而具体发送的数据必须在 object 的 data 字段;
    • Tip:WebSocket 服务器接口地址必须是 wss 协议,且域名必须是后台配置的合法域名;
    • Tip:线上版本只支持 wss 协议的请求,且域名必须是后台配置的合法域名;测试版同时支持 ws 和 wss 协议,请注意提审版本中的协议配置;
    • Tip:在创建 WebSocket 时,如果参数中 protocols 是非空,请确保 WebSocket 服务器能解析并且返回相应的 protocol,否则会创建 WebSocket 失败;
    • Tip:网络请求 referer 请参考小程序网络请求特性
    • Tip:请通过此 api 的回调判断 api 调用成功后,再调用返回实例上的方法,否则可能会导致执行失败。
    支持沙盒
    相关教程

    语法

    tt.connectSocket(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    urlstring
    Socket 连接地址
    1.0.0
    headerobject
    HTTP Header
    1.0.0
    protocolsArray<string>null
    子协议数组
    1.0.0
    successfunction
    接口调用成功的回调函数
    1.0.0
    failfunction
    接口调用失败的回调函数
    1.0.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.0.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    socketTaskIdnumber
    当前创建的 sockTask 的序号
    1.0.0
    errMsgstring
    "connectSocket:ok"
    1.0.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "connectSocket:fail" + 详细错误信息
    1.0.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例