capacitor 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

Для Intellisense или Typescript вам может потребоваться отредактировать файл @capacitor/core/dist/esm/core-plugin-definitions.ts. Убедитесь, что этот файл действительно загружен, поскольку могут существовать другие папки node_modules.

Справочник по API

API в некоторой степени похож на Chrome UDP API, но с привкусом конденсатора!

• создавать
• обновлять
• связывать
• отправлять
• закрывать
• closeAllSockets
• setBroadcast
• getSockets
• присоединиться к группе
• покинуть группу
• GetJoinedGroups
• УстановитьПауза
• setMulticastLoopbackMode

События:

• получать
• получить ошибку

Создавать

Создайте сокет для udp, и вы можете создать более одного сокета, отличающегося идентификатором сокета.

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

Отправлять

Конденсатор на данный момент не поддерживает 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, вы можете обратиться к Типизированные массивы.

Получить событие ошибки

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