Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brugsel/capacitor-udp
https://github.com/brugsel/capacitor-udp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brugsel/capacitor-udp
- Owner: brugsel
- Created: 2021-08-17T07:54:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-07T16:55:29.000Z (almost 2 years ago)
- Last Synced: 2024-07-03T19:48:03.471Z (4 months ago)
- Language: Java
- Size: 117 KB
- Stars: 4
- Watchers: 2
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-capacitor - UDP - Support both IPv6 and IPv4, multicast and broadcast. (Other plugins)
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
```bash
npm install @frontall/capacitor-udp
npx cap sync
```
## API
* [`create(...)`](#create)
* [`update(...)`](#update)
* [`setPaused(...)`](#setpaused)
* [`bind(...)`](#bind)
* [`send(...)`](#send)
* [`closeAllSockets()`](#closeallsockets)
* [`close(...)`](#close)
* [`getInfo(...)`](#getinfo)
* [`getSockets()`](#getsockets)
* [`joinGroup(...)`](#joingroup)
* [`leaveGroup(...)`](#leavegroup)
* [`setMulticastTimeToLive(...)`](#setmulticasttimetolive)
* [`setBroadcast(...)`](#setbroadcast)
* [`setMulticastLoopbackMode(...)`](#setmulticastloopbackmode)
* [`getJoinedGroups()`](#getjoinedgroups)
* [`addListener(...)`](#addlistener)
* [`addListener(...)`](#addlistener)
* [Interfaces](#interfaces)
### create(...)
```typescript
create(options?: { properties?: { name?: string | undefined; bufferSize?: number | undefined; } | undefined; } | undefined) => any
```
| Param | Type |
| ------------- | ---------------------------------------------------------------------- |
| **`options`** | { properties?: { name?: string; bufferSize?: number; }; } |
**Returns:** any
--------------------
### update(...)
```typescript
update(options: { socketId: number; properties: { name?: string; bufferSize?: number; }; }) => any
```
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------- |
| **`options`** | { socketId: number; properties: { name?: string; bufferSize?: number; }; } |
**Returns:** any
--------------------
### setPaused(...)
```typescript
setPaused(options: { socketId: number; paused: boolean; }) => any
```
| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | { socketId: number; paused: boolean; } |
**Returns:** any
--------------------
### bind(...)
```typescript
bind(options: { socketId: number; address: string; port: number; }) => any
```
| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| **`options`** | { socketId: number; address: string; port: number; } |
**Returns:** any
--------------------
### send(...)
```typescript
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()
```typescript
closeAllSockets() => any
```
**Returns:** any
--------------------
### close(...)
```typescript
close(options: { socketId: number; }) => any
```
| Param | Type |
| ------------- | ---------------------------------- |
| **`options`** | { socketId: number; } |
**Returns:** any
--------------------
### getInfo(...)
```typescript
getInfo(options: { socketId: number; }) => any
```
| Param | Type |
| ------------- | ---------------------------------- |
| **`options`** | { socketId: number; } |
**Returns:** any
--------------------
### getSockets()
```typescript
getSockets() => any
```
**Returns:** any
--------------------
### joinGroup(...)
```typescript
joinGroup(options: { socketId: number; address: string; }) => any
```
| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | { socketId: number; address: string; } |
**Returns:** any
--------------------
### leaveGroup(...)
```typescript
leaveGroup(options: { socketId: number; address: string; }) => any
```
| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | { socketId: number; address: string; } |
**Returns:** any
--------------------
### setMulticastTimeToLive(...)
```typescript
setMulticastTimeToLive(options: { socketId: number; ttl: number; }) => any
```
| Param | Type |
| ------------- | ----------------------------------------------- |
| **`options`** | { socketId: number; ttl: number; } |
**Returns:** any
--------------------
### setBroadcast(...)
```typescript
setBroadcast(options: { socketId: number; enabled: boolean; }) => any
```
| Param | Type |
| ------------- | ---------------------------------------------------- |
| **`options`** | { socketId: number; enabled: boolean; } |
**Returns:** any
--------------------
### setMulticastLoopbackMode(...)
```typescript
setMulticastLoopbackMode(options: { socketId: number; enabled: boolean; }) => any
```
| Param | Type |
| ------------- | ---------------------------------------------------- |
| **`options`** | { socketId: number; enabled: boolean; } |
**Returns:** any
--------------------
### getJoinedGroups()
```typescript
getJoinedGroups() => any
```
**Returns:** any
--------------------
### addListener(...)
```typescript
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(...)
```typescript
addListener(events: 'receiveError', functions: (params: string) => void) => PluginListenerHandle
```
| Param | Type |
| --------------- | ---------------------------------------- |
| **`events`** | "receiveError" |
| **`functions`** | (params: string) => void |
**Returns:** PluginListenerHandle
--------------------
### Interfaces
#### PluginListenerHandle
| Prop | Type |
| ------------ | ------------------------- |
| **`remove`** | () => any |