Rust-inspired communication library for asynchronous message passing.
JavaScript
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
examples
lib
test
.gitignore
.npmignore
.travis.yml
HISTORY.md
README.md
goodwin.conf.js
index.js
package.json

README.md

comm

Build Status

Rust-inspired communication primitives for asyncronous message passing.

Features

  • includes simplex and duplex communication patterns
  • designed for use with co and harmony generators
  • fallback to callbacks in non-generator environments
  • inspired by rust's std::comm and extra::comm modules

Installation

Node.js

comm is available through npm:

npm install comm

Example

More available in examples.

var co = require('co');
var Duplex = require('comm').Duplex;

function *calc(chan) {
  var sum = 0, num;

  while (num = yield chan.recv()) {
    sum += num;
  }

  chan.send(sum);
  chan.send(null);
}

co(function *main() {
  var sock = Duplex();
  var req = sock[0];

  co(calc)(sock[1]);

  req.send(2 * 10);
  req.send(2 * 20);
  req.send(2 * 30);
  req.send(null);

  var res = yield req.recv();
  console.log(res); // => 120
})();

Usage

TODO

License

(The MIT License)

Copyright (c) 2014 Jake Luer jake@alogicalparadox.com

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.