Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
tcp-base
Advanced tools
Readme
A base class for tcp client with basic functions
npm install tcp-base --save
Node.js >= 6.0.0 required
A quick guide to implement a tcp echo client
Client:
const TCPBase = require('tcp-base');
/**
* A Simple Protocol:
* (4B): request id
* (4B): body length
* ------------------------------
* body data
*/
class Client extends TCPBase {
getHeader() {
return this.read(8);
}
getBodyLength(header) {
return header.readInt32BE(4);
}
decode(body, header) {
return {
id: header.readInt32BE(0),
data: body,
};
}
// heartbeat packet
get heartBeatPacket() {
return Buffer.from([ 255, 255, 255, 255, 0, 0, 0, 0 ]);
}
}
const client = new Client({
host: '127.0.0.1',
port: 8080,
});
const body = Buffer.from('hello');
const data = Buffer.alloc(8 + body.length);
data.writeInt32BE(1, 0);
data.writeInt32BE(body.length, 4);
body.copy(data, 8, 0);
client.send({
id: 1,
data,
timeout: 5000,
}, (err, res) => {
if (err) {
console.error(err);
}
console.log(res.toString()); // should echo 'hello'
});
Server:
'use strict';
const net = require('net');
const server = net.createServer(socket => {
let header;
let bodyLen;
function readPacket() {
if (bodyLen == null) {
header = socket.read(8);
if (!header) {
return false;
}
bodyLen = header.readInt32BE(4);
}
if (bodyLen === 0) {
socket.write(header);
} else {
const body = socket.read(bodyLen);
if (!body) {
return false;
}
socket.write(Buffer.concat([ header, body ]));
}
bodyLen = null;
return true;
}
socket.on('readable', () => {
try {
let remaining = false;
do {
remaining = readPacket();
}
while (remaining);
} catch (err) {
console.error(err);
}
});
});
server.listen(8080);
FAQs
A base class for tcp client with basic functions
The npm package tcp-base receives a total of 17,784 weekly downloads. As such, tcp-base popularity was classified as popular.
We found that tcp-base demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.