@spryrocks/capacitor-socket-connection-plugin

Capacitor Socket Connection Plugin

Install

npm install @spryrocks/[email protected]

see main-capacitor5 branch for capacitor 5

see main-capacitor2 branch for capacitor 2

Usage

Create instance of socket connection class

const socket = new Socket();

Bind to events

onData

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

Callback function parameters

Name	Type
data	Uint8Array

onClose

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

onError

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

Callback function parameters

Name	Type
error	unknown

onStateChanges

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

Callback function parameters

Name	Type
state	SocketState

Connect socket to endpoint

await socket.open(host, port);

Parameters

Name	Type
host	String
port	Number

Write data to socket

await socket.write(data);

Parameters

Name	Type
data	Uint8Array

Close socket connection

await socket.close();

Get current state

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
• Thanks @daanvanhulst for updating the plugin to Capacitor 7 [#43]