分类： TCP 通信

TCPSocket.onMessage(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

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

参数

function listener

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

参数

Object res
属性 类型 说明
message ArrayBuffer 收到的消息
remoteInfo Object 发送端地址信息
结构属性 类型 说明
address string 发送消息的 socket 的地址
family string 使用的协议族，为 IPv4 或者 IPv6
port number 端口号
localInfo Object 接收端地址信息
结构属性 类型 说明
address string 接收消息的 socket 的地址
family string 使用的协议族，为 IPv4 或者 IPv6
port number 端口号

TCPSocket.onConnect(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

监听当一个 socket 连接成功建立的时候触发该事件

参数

function listener

当一个 socket 连接成功建立的时候触发该事件的监听函数

参数

Object res
属性 类型 说明 最低版本
useHttpDNS boolean 本次连接是否使用了 HttpDNS 3.4.0
exception Object 网络请求过程中的一些异常信息（例如：TCPSocket.connect 传了 enableHttpDNS: true，但最终未使用 HttpDNS 时，exception 就会说明未使用 HttpDNS 的原因） 3.4.0
结构属性 类型 说明 最低版本
reasons Array.<Object> 异常信息 3.4.0
结构属性 类型 说明
errMsg string 错误原因
errno string 错误码
remoteInfo Object 发送端地址信息（目前仅iOS和Android端支持） 3.4.1
结构属性 类型 说明 最低版本
address string 发送消息的 socket 的地址 3.4.1
family string 使用的协议族，为 IPv4 或者 IPv6 3.4.1
port number 端口号 3.4.1
localInfo Object 接收端地址信息（目前仅iOS和Android端支持） 3.4.1
结构属性 类型 说明 最低版本
address string 接收消息的 socket 的地址 3.4.1
family string 使用的协议族，为 IPv4 或者 IPv6 3.4.1
port number 端口号 3.4.1

TCPSocket.onBindWifi(function listener)

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

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

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

参数

function listener

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

TCPSocket.offMessage(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

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

参数

function listener

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

示例代码

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

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

TCPSocket.offError(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

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

参数

function listener

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

示例代码

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

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

TCPSocket.offConnect(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

移除当一个 socket 连接成功建立的时候触发该事件的监听函数

参数

function listener

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

示例代码

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

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

TCPSocket.offClose(function listener)

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明

功能描述

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

参数

function listener

通过 onClose 传入的监听函数。如果不传此参数，则移除所有监听函数。

示例代码

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

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