@spryrocks/capacitor-socket-connection-plugin

Capacitor Socket Connection Plugin

Install

``bash
npm install @spryrocks/capacitor-socket-connection-plugin@7.0.0
`

see main-capacitor5 branch for capacitor 5

see main-capacitor2 branch for capacitor 2

Usage

$3

`typescript
const socket = new Socket();
`

$3

#### onData

`typescript
socket.onData = function(data) {
// handle received data
};
`

##### Callback function parameters


| Name | Type |
| ---- | ---------- |
| data | Uint8Array |

#### onClose

`typescript
socket.onClose = function() {
// handle socket close
};
`

#### onError

`typescript
socket.onError = function(error) {
// handle socket error
};
`

##### Callback function parameters


| Name | Type |
| ----- | ------- |
| error | unknown |

#### onStateChanges

`typescript
socket.onStateChanged = function(state) {
// handle socket state change
};
`

##### Callback function parameters


| Name | Type |
| ----- | ----------- |
| state | SocketState |

$3

`typescript
await socket.open(host, port);
`

#### Parameters


| Name | Type |
| ---- | ------ |
| host | String |
| port | Number |

$3

`typescript
await socket.write(data);
`

#### Parameters


| Name | Type |
| ---- | ---------- |
| data | Uint8Array |

$3

`typescript
await socket.close();
`

$3

`typescript
const state = socket.state;
``

Q&A

Q: When I call the open method after being disconnected, I will be prompted that the open method can only be called once. How should I reconnect?

A: To re-connect the socket you should create the new socket and then open it.

Contributors

* Thanks @JEreth for fix gradle config by adding missing settings and dependencies #22
* Thanks @dreadnought for update the plugin to Capacitor 6 #28