capacitor udp

电容UDP

电容器的 UDP 插件灵感来自 cordova-plugin-chrome-apps-sockets-udp！同时支持IPv6和IPv4，组播和广播！

如需调试，请查看使用此插件开发的 Udper 应用程序！ https://play.google.com/store/apps/details?id=xyz.chenzhongkai.udper&hl=en_US

使用电容器，可以编写以下代码：

 async function process ( ) {
    try {
        await UdpPlugin . closeAllSockets ( ) ;
        let info = await UdpPlugin . create ( ) ;
        await UdpPlugin . bind ( { socketId : info . socketId , port : 5500 } )
        await UdpPlugin . send ( { socketId : info . socketId , address : targetAddress , port : 6000 , buffer : UdpPluginUtils . bufferToString ( data ) } ) } )
    } catch {
        //........
    }
}

是不是很神奇！

安装

$ npm install capacitor-udp

对于android开发，不要忘记在MainActivity中添加插件类！

TypeScript 特别提及！！！

 declare module '@capacitor/core'

有时无法按预期工作。我想像更改 core-plugin-definitions.ts 这样的脏解决方案可能是最值得信赖的解决方案。

例如，

 import { Plugin , PluginListenerHandle } from './definitions' ;
import { IUdpPlugin } from "capacitor-udp"
export interface PluginRegistry {
    Accessibility: AccessibilityPlugin ;
    App: AppPlugin ;
    BackgroundTask: BackgroundTaskPlugin ;
    Browser: BrowserPlugin ;
    // .............
    UdpPlugin: IUdpPlugin ;
    [ pluginName : string ] : {
        [ prop : string ] : any ;
    } ;
} 

用法

 import { Plugins } from "@capacitor/core" ;
const { UdpPlugin } = Plugins ;
import { UdpPluginUtils } from "capacitor-udp" ; // if you want support for converting between ArrayBuffer and String

对于智能感知或打字稿，您可能需要编辑 @capacitor/core/dist/esm/core-plugin-definitions.ts 中的文件。确保该文件已实际加载，因为可能还有其他 node_modules 文件夹。

API参考

该api在某种程度上类似于Chrome UDP API，但具有电容器的味道！

• 创造
• 更新
• 绑定
• 发送
• 关闭
• 关闭所有套接字
• 设置广播
• 获取套接字
• 加入群组
• 离开群组
• 获取已加入的组
• 设置暂停
• 设置组播环回模式

活动：

• 收到
• 接收错误

创造

为udp创建一个socket，并且可以创建多个通过socket id区分的socket。

 UdpPlugin . create ( { properties : { name : "yourSocketName" , bufferSize : 2048 } } ) . then ( res => { socketId = res . socketId } ) ;

更新

更新套接字信息，包括套接字名称和缓冲区大小。

 UdpPlugin . update ( { socketId : yourSocketId , properties : { name : "socketname" , bufferSize : 2048 } } )

绑定

在发送和接收数据之前，您需要绑定套接字。

 UdpPlugin . bind ( { socketId : yourSocketId , port : 5000 } )

发送

Capacitor暂时不支持Arraybuffer，所以我需要将ArrayBuffer转换为base64字符串。我提供了一个 util 函数来帮助您实现这一目标！

 UdpPlugin . send ( { socketId : yourSocketId , address : targetAddress , port : 6000 , buffer : bufferString } ) // bufferString is of type string
UdpPlugin . send ( { socketId : yourSocketId , address : targetAddress , port : 6000 , buffer : UdpPluginUtils . bufferToString ( data ) } ) // data is of type ArrayBuffer

关闭

关闭一个套接字

 UdpPlugin . close ( { socketId : yourSocketId } ) 

关闭所有套接字

 UdpPlugin . closeAllSockets ( ) 

设置广播

启用广播后，您可以发送目标地址为255.255.255.255的数据。

 UdpPlugin . setBroadcast ( { socketId : yourSocketId , enabled : enableBroadcastOrNot } ) 

获取套接字

获取所有可用的套接字。

 UdpPlugin . getSockets ( ) . then ( res => {
    //res contains sockets...
} )

加入群组

加入特定的组地址。对于 IPv4，它类似于“238.12.12.12”。对于 IPv6，它类似于“ff02::08”。

 UdpPlugin . joinGroup ( { socketId : yourSocketId , address : multicastAddress } )

离开群组

 UdpPlugin . leaveGroup ( { socketId : yourSocketId , address : multicastAddress } )

加入群组

 UdpPlugin . getJoinedGroups ( { socketId : yourSocketId } ) . then ( res => {
    // res contains your group addresses
} )

设置暂停

暂停接收数据。

 UdpPlugin . setPaused ( { socketId : yourSocketId , paused : pauseOrNot } )

设置组播环回模式

 UdpPlugin . setMulticastLoopbackMode ( { socketId : yourSocketId , enabled : enabledOrNot } )

接收事件

 UdpPlugin . addListener ( "receive" , data => {
    yourArrayBuffer = UdpPluginUtils . stringToBuffer ( data )
} } ) ;

对于ArrayBuffer的理解，可以参考Typed Arrays

接收错误事件

 UdpPlugin . addListener ( "receiveError" , error => { console . log ( error ) } ) ;