UDPSocket

title: UDPSocket

sidebar_label: UDPSocket

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

支持情况：

参考文档

方法

bind

绑定一个系统随机分配的可用端口，或绑定一个指定的端口号

支持情况：

参考文档

(port: number) => number

示例代码

const udp = Taro.createUDPSocket()
udp.close()

setTTL

设置 IP_TTL 套接字选项，用于设置一个 IP 数据包传输时允许的最大跳步数

支持情况：

参考文档

(ttl: number) => void

示例代码

const udp = Taro.createUDPSocket()
udp.onListening(function () {
  udp.setTTL(64)
})
udp.bind()

send

向指定的 IP 和 port 发送消息

支持情况：

参考文档

(option: Option) => void

示例代码

const udp = Taro.createUDPSocket()
udp.bind()
udp.send({
  address: '192.168.193.2',
  port: 8848,
  message: 'hello, how are you'
})

connect

预先连接到指定的 IP 和 port，需要配合 write 方法一起使用

支持情况：

参考文档

(option: Option) => void

write

用法与 send 方法相同，如果没有预先调用 connect 则与 send 无差异（注意即使调用了 connect 也需要在本接口填入地址和端口参数）

支持情况：

参考文档

() => void

close

关闭 UDP Socket 实例，相当于销毁。 在关闭之后，UDP Socket 实例不能再发送消息，每次调用 UDPSocket.send 将会触发错误事件，并且 message 事件回调函数也不会再也执行。在 UDPSocket 实例被创建后将被 Native 强引用，保证其不被 GC。在 UDPSocket.close 后将解除对其的强引用，让 UDPSocket 实例遵从 GC。

支持情况：

参考文档

() => void

onClose

监听关闭事件

支持情况：

参考文档

(callback: Callback) => void

offClose

取消监听关闭事件

支持情况：

参考文档

(callback: Callback) => void

onError

监听错误事件

支持情况：

参考文档

(callback: Callback) => void

offError

取消监听错误事件

支持情况：

参考文档

(callback: Callback) => void

onListening

监听开始监听数据包消息的事件

支持情况：

参考文档

(callback: Callback) => void

offListening

取消监听开始监听数据包消息的事件

支持情况：

参考文档

(callback: Callback) => void

onMessage

监听收到消息的事件

支持情况：

参考文档

(callback: Callback) => void

offMessage

取消监听收到消息的事件

支持情况：

参考文档

(callback: Callback) => void

参数

connect

Option

onClose

Callback

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

(args: unknown[]) => void

onError

Callback

错误事件的回调函数

(result: CallbackResult) => void

CallbackResult

onListening

Callback

监听开始监听数据包消息的事件

(args: unknown[]) => void

onMessage

Callback

收到消息的事件的回调函数

(result: CallbackResult) => void

CallbackResult

RemoteInfo

发送端地址信息

LocalInfo

接收端地址信息

send

Option

API 支持度