Giter Club home page Giter Club logo

mux-dmx's Introduction

MUX DMX

Multiple Duplex Streams across a single Duplex Stream.

Browser Support

Build Status

API

  var client1 = MuxDmx(),
      client2 = MuxDmx(),
      stream1 = client1.createDuplexStream(new Buffer([0])),
      stream2 = client2.createDuplexStream(new Buffer([0])),

  client1.pipe(client2).pipe(client1);

  stream1.on('data', function (data) {
    console.log(data.toString('utf8')); // Pong
  });

  stream2.on('data', function (data) {
    console.log(data.toString('utf8')); // Ping
  });

  stream1.write(new Buffer('Ping'));
  stream2.write(new Buffer('Pong'));

MuxDmx()

  • Return Duplex MuxDmx Stream

instance.createReadStream(id)

  • id Buffer
  • Return Readable Stream Multiplexed Read Stream

The id is received by the instance to distinguish the stream to push data to. The smaller the id, the smaller the framing sent.

instance.createWriteStream(id)

  • id Buffer
  • Return Writable Stream Multiplexed Writable Stream

The id is sent down the wire to distinguish the stream on the other side. The smaller the id, the smaller the framing sent.

instance.createDuplexStream(id)

  • id Buffer
  • Return Duplex Multiplexed Duplex Stream

Errors

instance will emit errors when it receives data that either has no defined stream or the stream with the id is only writable. This can be used as a security measure to close connections that are receiving unwanted data.

License

(The MIT License)

Copyright (c) 2014 RGBboy <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mux-dmx's People

Contributors

rgbboy avatar

Stargazers

Marcel Klehr avatar vlspopov avatar Beowul-Fu avatar

Watchers

James Cloos avatar  avatar

mux-dmx's Issues

Should have a close method like node's server.close

Stops the duplexer from accepting new streams and keeps existing streams. This function is asynchronous, the duplexer is finally closed when all streams are ended and the duplexer emits a 'close' event. Optionally, you can pass a callback to listen for the 'close' event.

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.