Junction/PubSub

XMPP Publish-Subscribe framework for Node, built on Junction.

Junction/PubSub is a minimalist framework layered on top of Junction, providing robust tooling to applications that need publish-subscribe functionality. The Junction/PubSub architecture is modeled upon the proven pairing of Connect + Express, making development of XMPP applications as simple as that of web applications.

Usage

Create an Application

To create a new application, simply invoke pubsub().

var app = pubsub();

Routing

Junction/PubSub uses the name of the <pubsub/> child element to provide a routing API. For example, an entity may wish to publish to a node:

app.publish('princely_musings', function(req, res, next) {
  // publish item
});

Mount and Connect to XMPP Network

Publish-Subscribe is a protocol that runs over XMPP, along side other extension protocols. Because of this, the pub-sub app is typically mounted as a sub-app of larger XMPP application.

var xmpp = junction()
  .use(junction.logger())
  .use(app);  // use pubsub app in larger XMPP app

xmpp.connect({ jid: '[email protected]', password: 's3cr3t' });

Tests

$ npm install --dev
$ make test

Credits

• Jared Hanson

License

(The MIT License)

Copyright (c) 2011 Jared Hanson

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.