capacitor udp

Condensateur UDP

Plugin UDP pour condensateur inspiré de cordova-plugin-chrome-apps-sockets-udp ! Prend en charge IPv6 et IPv4, multidiffusion et diffusion !

Pour le débogage, consultez l'application Udper développée à l'aide de ce plugin ! https://play.google.com/store/apps/details?id=xyz.chenzhongkai.udper&hl=en_US

Avec le condensateur, il est possible d'écrire le code suivant :

 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'est-ce pas incroyable !

Installer

$ npm install capacitor-udp

Pour le développement Android, n'oubliez pas d'ajouter la classe plugin dans MainActivity !

Mention spéciale TypeScript !!!

 declare module '@capacitor/core'

ne fonctionnent parfois pas comme prévu. Je suppose que la solution sale comme changer le core-plugin-definitions.ts pourrait être la solution la plus fiable.

Par exemple,

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

Usage

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

Pour Intellisense ou TypeScript, vous devrez peut-être modifier le fichier dans @capacitor/core/dist/esm/core-plugin-definitions.ts. Assurez-vous que ce fichier est réellement chargé, car il peut y avoir d'autres dossiers node_modules.

Référence API

L'API est dans une certaine mesure similaire à l'API Chrome UDP, mais avec le goût de condensateur !

• créer
• mise à jour
• lier
• envoyer
• fermer
• fermerToutes les prises
• setBroadcast
• obtenirSockets
• rejoindreGroupe
• quitterGroupe
• getJoinedGroups
• setPause
• setMulticastLoopbackMode

Événements:

• recevoir
• erreur de réception

Créer

Créez un socket pour udp et vous pouvez en créer plusieurs différenciés par l'identifiant du socket.

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

Mise à jour

Mettez à jour les informations sur le socket, y compris le nom du socket et la taille du tampon.

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

Lier

Vous devez lier un socket avant d'envoyer et de recevoir des données.

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

Envoyer

Capacitor ne prend pas en charge Arraybuffer pour le moment, je dois donc convertir ArrayBuffer en chaîne base64. J'ai fourni une fonction util pour vous aider à y parvenir !

 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

Fermer

Fermez une prise

 UdpPlugin . close ( { socketId : yourSocketId } ) 

Fermer toutes les prises

 UdpPlugin . closeAllSockets ( ) 

Définir la diffusion

Après avoir activé la diffusion, vous pouvez envoyer des données avec l'adresse cible 255.255.255.255.

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

Obtenir des prises

Procurez-vous toutes les prises disponibles.

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

Rejoindre le groupe

Rejoignez une adresse de groupe particulière. Pour IPv4, c'est comme "238.12.12.12". Pour IPv6, c'est comme "ff02::08".

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

Quitter le groupe

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

Rejoignez des groupes

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

Mettre en pause

Suspendre la réception des données.

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

Définir le mode de bouclage multidiffusion

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

Recevoir l'événement

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

Pour comprendre ArrayBuffer, vous pouvez vous référer à Typed Arrays

Réception d'un événement d'erreur

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