capacitor udp

Condensador UDP

¡Complemento UDP para condensador inspirado en cordova-plugin-chrome-apps-sockets-udp! ¡Admite IPv6 e IPv4, multidifusión y transmisión!

Para depurar, consulte la aplicación Udper desarrollada con este complemento. https://play.google.com/store/apps/details?id=xyz.chenzhongkai.udper&hl=en_US

Con condensador, es posible escribir el siguiente 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 {
        //........
    }
}

¿No es asombroso?

Instalar

$ npm install capacitor-udp

Para el desarrollo de Android, ¡no olvide agregar la clase de complemento en MainActivity!

Mención especial en TypeScript!!!

 declare module '@capacitor/core'

A veces no funciona como se esperaba. Supongo que la solución sucia, como cambiar core-plugin-definitions.ts, podría ser la solución más confiable.

Por ejemplo,

 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 o TypeScript, es posible que necesite editar el archivo en @capacitor/core/dist/esm/core-plugin-definitions.ts. Asegúrese de que este archivo esté realmente cargado, ya que puede haber otras carpetas node_modules.

Referencia de API

La API es hasta cierto punto similar a la API UDP de Chrome, ¡pero con sabor a condensador!

• crear
• actualizar
• unir
• enviar
• cerca
• cerrarTodos los enchufes
• setTransmitir
• obtenerSockets
• unirse al grupo
• salir del grupo
• getJoinedGroups
• establecer en pausa
• establecer modo de bucle invertido de multidifusión

Eventos:

• recibir
• recibirError

Crear

Cree un socket para udp y podrá crear más de uno diferenciado por la identificación del socket.

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

Actualizar

Actualice la información del socket, incluido el nombre del socket y el tamaño del búfer.

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

Unir

Debe vincular un socket antes de enviar y recibir datos.

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

Enviar

Capacitor no es compatible con Arraybuffer por ahora, por lo que necesito convertir ArrayBuffer a una cadena base64. ¡He proporcionado una función útil para ayudarte a lograrlo!

 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

Cerca

Cerrar un enchufe

 UdpPlugin . close ( { socketId : yourSocketId } ) 

Cerrar todos los enchufes

 UdpPlugin . closeAllSockets ( ) 

Establecer transmisión

Después de habilitar la transmisión, puede enviar datos con la dirección de destino 255.255.255.255.

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

Obtener enchufes

Obtenga todos los enchufes disponibles.

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

Unirse al grupo

Únase a una dirección de grupo en particular. Para IPv4, es como "238.12.12.12". Para IPv6, es como "ff02::08".

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

Dejar grupo

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

Unirse a grupos

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

Establecer en pausa

Pausar la recepción de datos.

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

Establecer el modo de bucle invertido de multidifusión

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

Recibir evento

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

Para comprender ArrayBuffer, puede consultar Typed Arrays

Recibir evento de error

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