level-channels

0.1.2 • Public • Published

SYNOPSIS

A simpler way to selectively stream future or historic changes.

USAGE

Here is an example using engine.io that allows you to pubulish and subscribe from the browser. See the tests for an example that uses tcp.

img

Server

Server (Part of a node program)

var Channels = require('level-channels');
var Engine = require('engine.io-stream');
var dbopts = { valueEncoding: 'json' };
var db = require('level')(__dirname + '/db', dbopts);
var httpserver = require('http').createServer().listen(8000);
 
var ch = Channels.createServer(db)
 
var engine = Engine(function (con) {
  con.pipe(ch).pipe(con);
});
engine.attach(httpserver, '/engine');

Client

Client (Part of a browserify bundle)

var engine = require('engine.io-stream');
var Channels = require('level-channels');
var ch = Channels.createClient(engine('/engine'));
 
ch.publish('some-channel', 'some-key', 'some-value');
ch.subscribe('some-channel').on('data', function(data) {
 
  // any client subscribed to `some-channel`
  // will receive `some-value`.
});

LICENSE

(MIT)

Copyright (c) 2013 Paolo Fragomeni (@hij1nx) paolo@async.ly

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.

Readme

Keywords

none

Package Sidebar

Install

npm i level-channels

Weekly Downloads

0

Version

0.1.2

License

MIT

Last publish

Collaborators

  • hij1nx