Version: 3.x

UDPSocket

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

参考文档

方法#

close#

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

参考文档

() => void

API 支持度#

API微信小程序H5React Native
UDPSocket.close✔️

offClose#

取消监听关闭事件

参考文档

(callback: OffCloseCallback) => void
参数类型说明
callbackOffCloseCallback关闭事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.offClose✔️

offError#

取消监听错误事件

参考文档

(callback: OffErrorCallback) => void
参数类型说明
callbackOffErrorCallback错误事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.offError✔️

offListening#

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

参考文档

(callback: (res: CallbackResult) => void) => void
参数类型说明
callback(res: CallbackResult) => void开始监听数据包消息的事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.offListening✔️

offMessage#

取消监听收到消息的事件

参考文档

(callback: (res: CallbackResult) => void) => void
参数类型说明
callback(res: CallbackResult) => void收到消息的事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.offMessage✔️

onClose#

监听关闭事件

参考文档

(callback: OnCloseCallback) => void
参数类型说明
callbackOnCloseCallback关闭事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.onClose✔️

onError#

监听错误事件

参考文档

(callback: OnErrorCallback) => void
参数类型说明
callbackOnErrorCallback错误事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.onError✔️

onListening#

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

参考文档

(callback: (res: CallbackResult) => void) => void
参数类型说明
callback(res: CallbackResult) => void开始监听数据包消息的事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.onListening✔️

onMessage#

监听收到消息的事件

参考文档

(callback: OnMessageCallback) => void
参数类型说明
callbackOnMessageCallback收到消息的事件的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.onMessage✔️

send#

向指定的 IP 和 port 发送消息

参考文档

(option: SendOption) => void
参数类型
optionSendOption

API 支持度#

API微信小程序H5React Native
UDPSocket.send✔️

bind#

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

参考文档

(port: number) => number
参数类型说明
portnumber指定要绑定的端口号

API 支持度#

API微信小程序H5React Native
UDPSocket.bind✔️

参数#

OffCloseCallback#

关闭事件的回调函数

(res: CallbackResult) => void
参数类型
resCallbackResult

OffErrorCallback#

错误事件的回调函数

(res: CallbackResult) => void
参数类型
resCallbackResult

OnCloseCallback#

关闭事件的回调函数

(res: CallbackResult) => void
参数类型
resCallbackResult

OnErrorCallback#

错误事件的回调函数

(result: OnErrorCallbackResult) => void
参数类型
resultOnErrorCallbackResult

OnMessageCallback#

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

(result: OnMessageCallbackResult) => void
参数类型
resultOnMessageCallbackResult

OnErrorCallbackResult#

参数类型说明
errMsgstring错误信息

OnMessageCallbackResult#

参数类型说明
messageArrayBuffer收到的消息
remoteInfoRemoteInfo消息来源的结构化信息

RemoteInfo#

消息来源的结构化信息

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

SendOption#

参数类型必填说明
datastring | ArrayBuffer需要发送的内容
complete(res: CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: CallbackResult) => void接口调用失败的回调函数
success(res: CallbackResult) => void接口调用成功的回调函数

API 支持度#

API微信小程序H5React Native
UDPSocket.close✔️
UDPSocket.offClose✔️
UDPSocket.offError✔️
UDPSocket.offListening✔️
UDPSocket.offMessage✔️
UDPSocket.onClose✔️
UDPSocket.onError✔️
UDPSocket.onListening✔️
UDPSocket.onMessage✔️
UDPSocket.send✔️
UDPSocket.bind✔️