TCPSocket

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

支持情况：

参考文档

方法

connect

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

支持情况：

参考文档

(option: Option) => void

参数	类型
option	Option

示例代码

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

write

在 socket 上发送数据

支持情况：

参考文档

(data: string | ArrayBuffer) => void

参数	类型	说明
data	string or ArrayBuffer	要发送的数据

示例代码

const tcp = Taro.createTCPSocket()
tcp.write('hello, how are you')

close

关闭连接

支持情况：

参考文档

() => void

示例代码

const tcp = Taro.createTCPSocket()
tcp.close()

onClose

监听关闭事件

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当一个 socket 完全关闭就发出该事件的回调函数

offClose

取消监听当一个 socket 完全关闭就发出该事件

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当一个 socket 完全关闭就发出该事件的回调函数

onConnect

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

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当一个 socket 连接成功建立的时候触发该事件的回调函数

offConnect

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

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当一个 socket 连接成功建立的时候触发该事件的回调函数

onError

监听当错误发生时触发

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	监听当错误发生时触发的回调函数

offError

取消监听当错误发生时触发

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	监听当错误发生时触发的回调函数

onMessage

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

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当接收到数据的时触发该事件的回调函数

offMessage

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

支持情况：

参考文档

(callback: Callback) => void

参数	类型	说明
callback	Callback	当接收到数据的时触发该事件的回调函数

参数

connect

Option

参数	类型	说明
address	string	套接字要连接的地址
port	number	套接字要连接的端口

onClose

Callback

当一个 socket 完全关闭就发出该事件的回调函数

(args: unknown[]) => void

参数	类型
args	unknown[]

onConnect

Callback

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

(args: unknown[]) => void

参数	类型
args	unknown[]

onError

Callback

监听当错误发生时触发的回调函数

(result: CallbackResult) => void

参数	类型
result	CallbackResult

CallbackResult

参数	类型	说明
errMsg	string	错误信息

onMessage

Callback

当接收到数据的时触发该事件的回调函数

(result: CallbackResult) => void

参数	类型
result	CallbackResult

CallbackResult

参数	类型	说明
message	ArrayBuffer	收到的消息
remoteInfo	RemoteInfo	发送端地址信息
localInfo	LocalInfo	接收端地址信息

RemoteInfo

发送端地址信息

参数	类型	说明
address	string	发送消息的 socket 的地址
family	string	使用的协议族，为 IPv4 或者 IPv6
port	number	端口号
size	number	message 的大小，单位：字节

LocalInfo

接收端地址信息

参数	类型	说明
address	string	接收消息的 socket 的地址
family	string	使用的协议族，为 IPv4 或者 IPv6
port	number	端口号

API 支持度

API	微信小程序	H5	React Native	Harmony
TCPSocket	✔️
TCPSocket.connect	✔️
TCPSocket.write	✔️
TCPSocket.close	✔️
TCPSocket.onClose	✔️
TCPSocket.offClose	✔️
TCPSocket.onConnect	✔️
TCPSocket.offConnect	✔️
TCPSocket.onError	✔️
TCPSocket.offError	✔️
TCPSocket.onMessage	✔️
TCPSocket.offMessage	✔️