tcp-bridge
Description
This is a small framework for connecting 2 or more servers to each other by tcp.
The framework has the function of automatic reconnection to each server, the sending queue, the lifetime of the tasks for sending.
Installation
With yarn
:
yarn add tcp-bridge
or with npm
:
npm install tcp-bridge
Usage
For a simple connection of two servers on localhost, you can do this:
const BridgeClass = ;const Bridge = ;Bridge;Bridge;
If possible, connections will be established to servers localhost:2020
and localhost:3030
.
All data from server 1 will be sent to server 2. All data from server 2 will be sent to server 1.
Servers may be more
require('tcp-bridge')
returns constructor of Bridge
class.
To create new instance of Bridge
you can do this:
const BridgeClass = ;const Bridge = ;
For debugging you can use debug npm package or with same functionality.
Example debugging:
Install debug
package:
yarn add debug
or:
npm install debug
then code:
const BridgeClass = ;const debug = ;const Bridge = debug;
and run script with debug env variable, ex.:
DEBUG=* node index.js
BridgeInstance functions
addPoint(params)
-> point uuid
identifier
#Adds a new server, initiates a connection and returns a unique identifier.
Signature:
BridgeInstance.addPoint({
port,
host,
reconnectOnClose,
reconnectOnHasSendData,
checkTime,
taskTimeout,
enabledRedirect,
encoding,
})
Parameter | Required | Description | Default value |
---|---|---|---|
port |
true |
Port of server | |
host |
Hostname (or ip) of server | '127.0.0.1' |
|
reconnectOnClose |
auto reconnect on close connection | true |
|
reconnectOnHasSendData |
auto reconnect if connection is closed and clinet has data to send | false |
|
checkTime |
time to check new data for sending | 300 ms |
|
taskTimeout |
task lifetime (in ms), 0 for disable |
60000 |
|
enabledRedirect |
if false - data from this point will not be redirected | true |
|
encoding |
Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information. | null |
removePoint(identifier)
#Disconnects and removes server by identifier.
Parameter | Required | Description | Default value |
---|---|---|---|
identifier |
true |
Identifier of point (server) |
sendDataToPoint(identifier, data)
#Send data to one point.
Parameter | Required | Description | Default value |
---|---|---|---|
identifier |
true |
Identifier of point (server) | |
data |
true |
Bytes (as in net library in socket.send function) |
getPoint(identifier)
-> point instance
#Getting one point instance.
Parameter | Required | Description | Default value |
---|---|---|---|
identifier |
true |
Identifier of point (server) |
Client (Point) functions and properties
enableRedirect()
#Data from this point will be redirected.
disableRedirect()
#Data from this point will not be redirected.
on('data', callback)
– event, triggered if data will be received
#on('ready')
– event, triggered if connection is activated
#.connected
– true, if connection to server is active
property More examples
4 servers with debug and encoding UTF8
const debug = ;const BridgeClass = ;const Bridge = debug; const firstUid = Bridge;Bridge;Bridge;Bridge; Bridge; const lastUid = Bridge; const point = Bridge;point;point;