capacitor udp

Capacitor UDP

Plugin UDP para Capacitor inspirado em cordova-plugin-chrome-apps-sockets-udp! Suporta IPv6 e IPv4, multicast e broadcast!

Para depuração, confira o aplicativo Udper desenvolvido com este plugin! https://play.google.com/store/apps/details?id=xyz.chenzhongkai.udper&hl=en_US

Com capacitor, é possível escrever o seguinte código:

 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 {
        //........
    }
}

Não é incrível!

Instalar

$ npm install capacitor-udp

Para desenvolvimento Android, não esqueça de adicionar a classe plugin na MainActivity!

Menção especial datilografada!!!

 declare module '@capacitor/core'

às vezes não funcionam conforme o esperado. Acho que a solução suja, como alterar core-plugin-definitions.ts, pode ser a solução mais confiável.

Por exemplo,

 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 ;
    } ;
} 

Uso

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

Para intellisense ou typescript, pode ser necessário editar o arquivo em @capacitor/core/dist/esm/core-plugin-definitions.ts. Certifique-se de que este arquivo esteja realmente carregado, pois pode haver outras pastas node_modules.

Referência de API

A API é até certo ponto semelhante à API UDP do Chrome, mas com gosto de capacitor!

• criar
• atualizar
• vincular
• enviar
• fechar
• fecharTodosSockets
• definir transmissão
• getSockets
• juntar-se ao grupo
• sair do grupo
• getJoinedGroups
• setPausado
• setMulticastLoopbackMode

Eventos:

• receber
• receberErro

Criar

Crie um soquete para udp, podendo criar mais de um diferenciado pelo ID do soquete.

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

Atualizar

Atualize as informações do soquete, incluindo o nome do soquete e o tamanho do buffer.

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

Vincular

Você precisa vincular um soquete antes de enviar e receber dados.

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

Enviar

O capacitor não suporta Arraybuffer por enquanto, então preciso converter ArrayBuffer em string base64. Eu forneci uma função util para ajudá-lo a conseguir isso!

 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

Fechar

Feche um soquete

 UdpPlugin . close ( { socketId : yourSocketId } ) 

Fechar todos os soquetes

 UdpPlugin . closeAllSockets ( ) 

Definir transmissão

Após habilitar a transmissão, você pode enviar dados com endereço de destino 255.255.255.255.

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

Obtenha soquetes

Obtenha todos os soquetes disponíveis.

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

Junte-se ao grupo

Junte-se a um endereço de grupo específico. Para IPv4, é como "238.12.12.12". Para IPv6, é como "ff02::08".

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

Sair do grupo

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

Junte-se a grupos

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

Definir pausado

Pause o recebimento de dados.

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

Definir modo de loopback multicast

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

Receber Evento

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

Para entender o ArrayBuffer, você pode consultar Arrays digitados

Receber evento de erro

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