Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

quick-tcp-socket

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

quick-tcp-socket

Simple wrapper for net.Socket to send/receive JSON objects and Buffer streams.

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

Simple wrapper for net.Socket to send/receive JSON objects and Buffer streams.
Made as much faster alternative to socket.io + socket.io-stream

Install

$ npm install quick-tcp-socket

Use example


const {
  TcpSocket, ReadBufferStream, WriteBufferStream
} = require('quick-tcp-socket');

//
// Client
//
let clientSocket = net.connect(port, host, () => {
  client = new TcpSocket(false, clientSocket);

  client.sendPacket("getData1", {
    param1: 1,
  });
  client.once("setData1", (data) => {
    // data == {a: 1, b: 2}
  });

  client.on('close', () => { //disconnected });
  client.on('error', (err) => { console.error(err); });

  let readStream = fs.createReadStream("file.txt");
  client.sendPacketAndStreams("setStream1", {size: 100}, readStream);
});


//
// Server
//
net.createServer({}, (clientSocket) => {
  let client = new TcpSocket(true, clientSocket);

  client.on('getData1', (params) => {
    // params.param1 == 1
    client.sendPacket('setData1', {
      a: 1, b: 2
    });
  });

  client.on("setStream1", (data) => {
    // data.size == 100
    let writeStream = fs.createWriteStream("file.txt");
    client.receiveStreams([writeStream], () => {
      //stream received
    });
  });

  client.on('close', () => { //client disconnected });
  client.on('error', (err) => { console.error(err); });
});

API

todo...

Keywords

FAQs

Package last updated on 11 Jan 2017

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc