分类： TCP 通信

TCPSocket.offBindWifi(function listener)

基础库 2.25.0 开始支持，低版本需做兼容处理。

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

移除当一个 socket 绑定当前 wifi 网络成功时触发该事件的监听函数

参数

function listener

onBindWifi 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

TCPSocket.onBindWifi(listener)
TCPSocket.offBindWifi(listener) // 需传入与监听时同一个的函数对象

TCPSocket.connect(Object options)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

在指定的套接字上启动连接

参数

Object options

属性 类型 默认值 必填 说明 最低版本
address string 是 套接字要连接的地址
port number 是 套接字要连接的端口
timeout number 2 否 套接字连接的超时时间，默认为 2 秒
enableHttpDNS boolean false 否 是否开启 HttpDNS 服务。如果开启，需要同时填入 httpDNSServiceId。HttpDNS 用法详见移动解析 HttpDNS 3.4.0
httpDNSServiceId string 否 HttpDNS 服务商 ID。HttpDNS 用法详见移动解析 HttpDNS 3.4.0

示例代码


  const tcp = wx.createTCPSocket()
  tcp.connect({address: '192.168.193.2', port: 8848})

TCPSocket.bindWifi(Object options)

基础库 2.25.0 开始支持，低版本需做兼容处理。

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

将 TCP Socket 绑定到当前 wifi 网络，成功后会触发 onBindWifi 事件（仅安卓支持）

参数

Object options

属性 类型 默认值 必填 说明
BSSID string 是 当前 wifi 网络的 BSSID ，可通过 wx.getConnectedWifi 获取

示例代码


  const tcp = wx.createTCPSocket()
  tcp.bindWifi({ BSSID: 'xxx' })
  tcp.onBindWifi(() => {})

TCPSocket

基础库 2.18.0 开始支持，低版本需做兼容处理。

相关文档: 网络使用说明

一个 TCP Socket 实例，默认使用 IPv4 协议

方法

TCPSocket.bindWifi(Object options)

将 TCP Socket 绑定到当前 wifi 网络，成功后会触发 onBindWifi 事件（仅安卓系统支持）

TCPSocket.connect(Object options)

在给定的套接字上启动连接

TCPSocket.write(string|ArrayBuffer data)

在 socket 上发送数据

TCPSocket.close()

关闭连接

TCPSocket.onClose(function listener)

监听 socket 完全关闭时触发的事件

TCPSocket.offClose(function listener)

移除 socket 完全关闭时触发的事件的监听函数

TCPSocket.onConnect(function listener)

监听 socket 连接成功建立时触发的事件

TCPSocket.offConnect(function listener)

移除 socket 连接成功建立时触发的事件的监听函数

TCPSocket.onError(function listener)

监听错误发生时触发的事件

TCPSocket.offError(function listener)

移除错误发生时触发的事件的监听函数

TCPSocket.onMessage(function listener)

监听接收到数据时触发的事件

TCPSocket.offMessage(function listener)

移除接收到数据时触发的事件的监听函数

TCPSocket.onBindWifi(function listener)

监听 socket 绑定当前 wifi 网络成功时触发的事件

TCPSocket.offBindWifi(function listener)

移除 socket 绑定当前 wifi 网络成功时触发的事件的监听函数

错误

错误码 错误信息 说明
-1 系统错误
-2 socket接口错误，可参考系统的socket错误码
-3 发送失败，无接口权限
-4 连接失败
1 发送失败，参数错误，address不合法
2 发送失败，参数错误，port不合法
3 绑定wifi网络失败，BSSID不合法
4 绑定wifi网络失败，系统错误
5 绑定wifi网络失败，该接口仅在安卓平台支持
6 绑定wifi网络失败，低版本安卓不支持该接口

注意

  • 当 errCode 为 -2 时，errMsg 里应该会有相应的 errno ，开发者可以根据 errno 到 linux 代码里的 errno-base.h 和 errno.h 中查看具体的报错信息。

TCPSocketwx.createTCPSocket(Object object)

基础库 2.18.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

创建一个 TCP Socket 实例。使用前请注意阅读相关说明。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
type string ipv4 否 套接字族，必须是 IPv4 或者 IPv6，默认是 IPv4 3.6.4
合法值 说明
ipv4 IPv4
ipv6 IPv6

返回值

TCPSocket

一个 TCP Socket 实例

连接限制

  • 允许与局域网内的非本机 IP 通信
  • 允许与配置过的服务器域名通信，详见相关说明
  • 禁止与以下端口号连接：1024 以下 1099 1433 1521 1719 1720 1723 2049 2375 3128 3306 3389 3659 4045 5060 5061 5432 5984 6379 6000 6566 7001 7002 8000-8100 8443 8888 9200 9300 10051 10080 11211 27017 27018 27019
  • 每 5 分钟内最多创建 20 个 TCPSocket