Version: 2.2.1
UDPSocket
一个 UDP Socket 实例，默认使用 IPv4 协议。
方法
close
关闭 UDP Socket 实例，相当于销毁。 在关闭之后，UDP Socket 实例不能再发送消息，每次调用 UDPSocket.send 将会触发错误事件，并且 message 事件回调函数也不会再也执行。在 UDPSocket 实例被创建后将被 Native 强引用，保证其不被 GC。在 UDPSocket.close 后将解除对其的强引用，让 UDPSocket 实例遵从 GC。
() => void
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.close | ✔️ |
offClose
取消监听关闭事件
(callback: OffCloseCallback) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | OffCloseCallback | 关闭事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.offClose | ✔️ |
offError
取消监听错误事件
(callback: OffErrorCallback) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | OffErrorCallback | 错误事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.offError | ✔️ |
offListening
取消监听开始监听数据包消息的事件
(callback: (res: CallbackResult) => void) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | (res: CallbackResult) => void | 开始监听数据包消息的事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.offListening | ✔️ |
offMessage
取消监听收到消息的事件
(callback: (res: CallbackResult) => void) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | (res: CallbackResult) => void | 收到消息的事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.offMessage | ✔️ |
onClose
监听关闭事件
(callback: OnCloseCallback) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | OnCloseCallback | 关闭事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.onClose | ✔️ |
onError
监听错误事件
(callback: OnErrorCallback) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | OnErrorCallback | 错误事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.onError | ✔️ |
onListening
监听开始监听数据包消息的事件
(callback: (res: CallbackResult) => void) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | (res: CallbackResult) => void | 开始监听数据包消息的事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.onListening | ✔️ |
onMessage
监听收到消息的事件
(callback: OnMessageCallback) => void
| 参数 | 类型 | 说明 |
|---|---|---|
| callback | OnMessageCallback | 收到消息的事件的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.onMessage | ✔️ |
send
向指定的 IP 和 port 发送消息
(option: SendOption) => void
| 参数 | 类型 |
|---|---|
| option | SendOption |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.send | ✔️ |
bind
绑定一个系统随机分配的可用端口，或绑定一个指定的端口号
(port: number) => number
| 参数 | 类型 | 说明 |
|---|---|---|
| port | number | 指定要绑定的端口号 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.bind | ✔️ |
参数
OffCloseCallback
关闭事件的回调函数
(res: CallbackResult) => void
| 参数 | 类型 |
|---|---|
| res | CallbackResult |
OffErrorCallback
错误事件的回调函数
(res: CallbackResult) => void
| 参数 | 类型 |
|---|---|
| res | CallbackResult |
OnCloseCallback
关闭事件的回调函数
(res: CallbackResult) => void
| 参数 | 类型 |
|---|---|
| res | CallbackResult |
OnErrorCallback
错误事件的回调函数
(result: OnErrorCallbackResult) => void
| 参数 | 类型 |
|---|---|
| result | OnErrorCallbackResult |
OnMessageCallback
收到消息的事件的回调函数
(result: OnMessageCallbackResult) => void
| 参数 | 类型 |
|---|---|
| result | OnMessageCallbackResult |
OnErrorCallbackResult
| 参数 | 类型 | 说明 |
|---|---|---|
| errMsg | string | 错误信息 |
OnMessageCallbackResult
| 参数 | 类型 | 说明 |
|---|---|---|
| message | ArrayBuffer | 收到的消息 |
| remoteInfo | RemoteInfo | 消息来源的结构化信息 |
RemoteInfo
消息来源的结构化信息
| 参数 | 类型 | 说明 |
|---|---|---|
| address | string | 发送消息的 socket 的地址 |
| family | string | 使用的协议族，为 IPv4 或者 IPv6 |
| port | number | 端口号 |
| size | number | message 的大小，单位：字节 |
SendOption
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | string | ArrayBuffer | 是 | 需要发送的内容 |
| complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
| success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
API 支持度
| API | 微信小程序 | H5 | React Native |
|---|---|---|---|
| UDPSocket.close | ✔️ | ||
| UDPSocket.offClose | ✔️ | ||
| UDPSocket.offError | ✔️ | ||
| UDPSocket.offListening | ✔️ | ||
| UDPSocket.offMessage | ✔️ | ||
| UDPSocket.onClose | ✔️ | ||
| UDPSocket.onError | ✔️ | ||
| UDPSocket.onListening | ✔️ | ||
| UDPSocket.onMessage | ✔️ | ||
| UDPSocket.send | ✔️ | ||
| UDPSocket.bind | ✔️ |