@nws/capacitor-udp
v1.3.4
Published
UDP Plugin for CapacitorJS inspired by the UDP Plugin of https://github.com/unitree-czk/capacitor-udp updated to support capacitor 5
Downloads
2
Readme
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 capacitor-udp
npx cap sync
API
create(...)
update(...)
setPaused(...)
bind(...)
send(...)
closeAllSockets()
close(...)
getInfo(...)
getSockets()
joinGroup(...)
leaveGroup(...)
setMulticastTimeToLive(...)
setBroadcast(...)
setMulticastLoopbackMode(...)
getJoinedGroups()
addListener(...)
addListener(...)
- Interfaces
create(...)
create(options?: { properties?: { name?: string | undefined; bufferSize?: number | undefined; } | undefined; } | undefined) => any
| Param | Type |
| ------------- | ---------------------------------------------------------------------- |
| options
| { properties?: { name?: string; bufferSize?: number; }; } |
Returns: any
update(...)
update(options: { socketId: number; properties: { name?: string; bufferSize?: number; }; }) => any
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------- |
| options
| { socketId: number; properties: { name?: string; bufferSize?: number; }; } |
Returns: any
setPaused(...)
setPaused(options: { socketId: number; paused: boolean; }) => any
| Param | Type |
| ------------- | --------------------------------------------------- |
| options
| { socketId: number; paused: boolean; } |
Returns: any
bind(...)
bind(options: { socketId: number; address: string; port: number; }) => any
| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options
| { socketId: number; address: string; port: number; } |
Returns: any
send(...)
send(options: { socketId: number; address: string; port: number; buffer: string; }) => any
| Param | Type |
| ------------- | --------------------------------------------------------------------------------- |
| options
| { socketId: number; address: string; port: number; buffer: string; } |
Returns: any
closeAllSockets()
closeAllSockets() => any
Returns: any
close(...)
close(options: { socketId: number; }) => any
| Param | Type |
| ------------- | ---------------------------------- |
| options
| { socketId: number; } |
Returns: any
getInfo(...)
getInfo(options: { socketId: number; }) => any
| Param | Type |
| ------------- | ---------------------------------- |
| options
| { socketId: number; } |
Returns: any
getSockets()
getSockets() => any
Returns: any
joinGroup(...)
joinGroup(options: { socketId: number; address: string; }) => any
| Param | Type |
| ------------- | --------------------------------------------------- |
| options
| { socketId: number; address: string; } |
Returns: any
leaveGroup(...)
leaveGroup(options: { socketId: number; address: string; }) => any
| Param | Type |
| ------------- | --------------------------------------------------- |
| options
| { socketId: number; address: string; } |
Returns: any
setMulticastTimeToLive(...)
setMulticastTimeToLive(options: { socketId: number; ttl: number; }) => any
| Param | Type |
| ------------- | ----------------------------------------------- |
| options
| { socketId: number; ttl: number; } |
Returns: any
setBroadcast(...)
setBroadcast(options: { socketId: number; enabled: boolean; }) => any
| Param | Type |
| ------------- | ---------------------------------------------------- |
| options
| { socketId: number; enabled: boolean; } |
Returns: any
setMulticastLoopbackMode(...)
setMulticastLoopbackMode(options: { socketId: number; enabled: boolean; }) => any
| Param | Type |
| ------------- | ---------------------------------------------------- |
| options
| { socketId: number; enabled: boolean; } |
Returns: any
getJoinedGroups()
getJoinedGroups() => any
Returns: any
addListener(...)
addListener(events: 'receive', functions: (params: { socketId: number; buffer: string; }) => void) => PluginListenerHandle
| Param | Type |
| --------------- | ----------------------------------------------------------------------- |
| events
| "receive" |
| functions
| (params: { socketId: number; buffer: string; }) => void |
Returns: PluginListenerHandle
addListener(...)
addListener(events: 'receiveError', functions: (params: string) => void) => PluginListenerHandle
| Param | Type |
| --------------- | ---------------------------------------- |
| events
| "receiveError" |
| functions
| (params: string) => void |
Returns: PluginListenerHandle
Interfaces
PluginListenerHandle
| Prop | Type |
| ------------ | ------------------------- |
| remove
| () => any |