@blade86/capacitor-udp v0.5.43

capacitor-udp

UDP Plugin for CapacitorJS based on the UDP Plugin of https://github.com/unitree-czk/capacitor-udp which is no longer maintained. So a new repo to push the plugin to be suitable for CapacitorJS 3+.

Install

npm install @frontall/capacitor-udp
npx cap sync

API

• create(...)
• update(...)
• setPaused(...)
• bind(...)
• send(...)
• closeAllSockets()
• close(...)
• getInfo(...)
• getSockets()
• joinGroup(...)
• leaveGroup(...)
• setMulticastTimeToLive(...)
• setBroadcast(...)
• setMulticastLoopbackMode(...)
• getJoinedGroups()
• addListener('receive', ...)
• addListener('receiveError', ...)
• Interfaces
• Type Aliases

create(...)

create(options?: { properties?: { name?: string | undefined; bufferSize?: number | undefined; } | undefined; } | undefined) => Promise<{ socketId: number; ipv4: string; ipv6: string; }>

Returns: Promise<{ socketId: number; ipv4: string; ipv6: string; }>

update(...)

update(options: { socketId: number; properties: { name?: string; bufferSize?: number; }; }) => Promise<any>

Returns: Promise<any>

setPaused(...)

setPaused(options: { socketId: number; paused: boolean; }) => Promise<any>

Returns: Promise<any>

bind(...)

bind(options: { socketId: number; address: string; port: number; }) => Promise<any>

Returns: Promise<any>

send(...)

send(options: { socketId: number; address: string; port: number; buffer: string; }) => Promise<any>

Returns: Promise<any>

closeAllSockets()

closeAllSockets() => Promise<any>

Returns: Promise<any>

close(...)

close(options: { socketId: number; }) => Promise<any>

Returns: Promise<any>

getInfo(...)

getInfo(options: { socketId: number; }) => Promise<{ socketId: number; bufferSize: number; name: string | null; paused: boolean; localAddress?: string; localPort?: number; }>

Returns: Promise<{ socketId: number; bufferSize: number; name: string | null; paused: boolean; localAddress?: string; localPort?: number; }>

getSockets()

getSockets() => Promise<{ sockets: [ { socketId: number; bufferSize: number; name: string | null; paused: boolean; localAddress?: string; localPort?: number; } ]; }>

Returns: Promise<{ sockets: { socketId: number; bufferSize: number; name: string | null; paused: boolean; localAddress?: string; localPort?: number; }; }>

joinGroup(...)

joinGroup(options: { socketId: number; address: string; }) => Promise<any>

Returns: Promise<any>

leaveGroup(...)

leaveGroup(options: { socketId: number; address: string; }) => Promise<any>

Returns: Promise<any>

setMulticastTimeToLive(...)

setMulticastTimeToLive(options: { socketId: number; ttl: number; }) => Promise<any>

Returns: Promise<any>

setBroadcast(...)

setBroadcast(options: { socketId: number; enabled: boolean; }) => Promise<any>

Returns: Promise<any>

setMulticastLoopbackMode(...)

setMulticastLoopbackMode(options: { socketId: number; enabled: boolean; }) => Promise<any>

Returns: Promise<any>

getJoinedGroups()

getJoinedGroups() => Promise<{ groups: [string]; }>

Returns: Promise<{ groups: string; }>

addListener('receive', ...)

addListener(events: 'receive', functions: (params: { socketId: number; buffer: string; }) => void) => PluginListenerHandle

Returns: PluginListenerHandle

addListener('receiveError', ...)

addListener(events: 'receiveError', functions: (params: UdpReceiveError) => void) => PluginListenerHandle

Returns: PluginListenerHandle

Interfaces

PluginListenerHandle

Type Aliases

UdpReceiveError

{ code: number; message: string; }