Skip to main content
Version: 3.x

TCPSocket

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

支持情况:

参考文档

方法

connect

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

支持情况:

参考文档

(option: Option) => void
参数类型
optionOption

示例代码

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

write

在 socket 上发送数据

支持情况:

参考文档

(data: string | ArrayBuffer) => void
参数类型说明
datastring or ArrayBuffer要发送的数据

示例代码

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

close

关闭连接

支持情况:

参考文档

() => void

示例代码

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

onClose

监听关闭事件

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback当一个 socket 完全关闭就发出该事件的回调函数

offClose

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

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback当一个 socket 完全关闭就发出该事件的回调函数

onConnect

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

支持情况:

参考文档

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

offConnect

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

支持情况:

参考文档

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

onError

监听当错误发生时触发

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback监听当错误发生时触发的回调函数

offError

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

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback监听当错误发生时触发的回调函数

onMessage

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

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback当接收到数据的时触发该事件的回调函数

offMessage

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

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback当接收到数据的时触发该事件的回调函数

参数

connect

Option

参数类型说明
addressstring套接字要连接的地址
portnumber套接字要连接的端口

onClose

Callback

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

(args: unknown[]) => void
参数类型
argsunknown[]

onConnect

Callback

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

(args: unknown[]) => void
参数类型
argsunknown[]

onError

Callback

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

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
errMsgstring错误信息

onMessage

Callback

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

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
messageArrayBuffer收到的消息
remoteInfoRemoteInfo发送端地址信息
localInfoLocalInfo接收端地址信息

RemoteInfo

发送端地址信息

参数类型说明
addressstring发送消息的 socket 的地址
familystring使用的协议族,为 IPv4 或者 IPv6
portnumber端口号
sizenumbermessage 的大小,单位:字节

LocalInfo

接收端地址信息

参数类型说明
addressstring接收消息的 socket 的地址
familystring使用的协议族,为 IPv4 或者 IPv6
portnumber端口号

API 支持度

API微信小程序H5React NativeHarmony
TCPSocket✔️
TCPSocket.connect✔️
TCPSocket.write✔️
TCPSocket.close✔️
TCPSocket.onClose✔️
TCPSocket.offClose✔️
TCPSocket.onConnect✔️
TCPSocket.offConnect✔️
TCPSocket.onError✔️
TCPSocket.offError✔️
TCPSocket.onMessage✔️
TCPSocket.offMessage✔️