TCPSocket

title: TCPSocket

sidebar_label: TCPSocket

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

支持情况：

参考文档

方法

connect

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

支持情况：

参考文档

(option: Option) => void

示例代码

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

write

在 socket 上发送数据

支持情况：

参考文档

(data: string | ArrayBuffer) => void

示例代码

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

close

关闭连接

支持情况：

参考文档

() => void

示例代码

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

onClose

监听关闭事件

支持情况：

参考文档

(callback: Callback) => void

offClose

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

支持情况：

参考文档

(callback: Callback) => void

onConnect

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

支持情况：

参考文档

(callback: Callback) => void

offConnect

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

支持情况：

参考文档

(callback: Callback) => void

onError

监听当错误发生时触发

支持情况：

参考文档

(callback: Callback) => void

offError

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

支持情况：

参考文档

(callback: Callback) => void

onMessage

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

支持情况：

参考文档

(callback: Callback) => void

offMessage

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

支持情况：

参考文档

(callback: Callback) => void

参数

connect

Option

onClose

Callback

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

(args: unknown[]) => void

onConnect

Callback

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

(args: unknown[]) => void

onError

Callback

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

(result: CallbackResult) => void

CallbackResult

onMessage

Callback

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

(result: CallbackResult) => void

CallbackResult

RemoteInfo

发送端地址信息

LocalInfo

接收端地址信息

API 支持度