Code Monkey home page Code Monkey logo

boundary-stream's Introduction

Boundary Stream

npm

Boundary stream converts passed data into length prefixed buffers. It helps to send data via tcp connection. Length prefixed protocols are more speed efficient then delimiter based (like HTTP).

Boundary stream can handle any size of message. The only limit is RAM size. It supports String or Buffer transfer and fits for JSON, MsgPack, CBOR and BORN encoders.

Install

Install via npm:

npm i boundary-stream

Usage

Example of raw Buffer message transfer.

Client

const net = require('net');
const boundary = require('boundary-stream');

const conn = net.connect(9090);

conn.on('connect', () => {
    const writer = boundary.writer();

    writer.pipe(conn);

    writer.write(Buffer.alloc(10 * 1024 * 1024)); // Send 10 MiB buffer
    writer.end();
});

// ...

Server

const net = require('net');
const boundary = require('boundary-stream');

const server = net.createServer(function(conn){
    let reader = boundary.reader();

    reader.on('data', (message) => {
        console.log(message.length); // -> 10485760
    });

    conn.pipe(reader);
});

// ...

API

writer() -> Writer{}

Create Writer instance.

reader() -> Reader{}

Create Reader instance.

Writer()

Writer constructor

Writer().write(String|Buffer)

Write message to stream.

Reader()

Reader constructor

License

MIT

boundary-stream's People

Contributors

rumkin avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.