Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.95 KB

README.markdown

File metadata and controls

81 lines (58 loc) · 2.95 KB
Raw

faye-redis Build Status

This plugin provides a Redis-based backend for the Faye messaging server. It allows a single Faye service to be distributed across many front-end web servers by storing state and routing messages through a Redis database server.

Usage

Pass in the engine and any settings you need when setting up your Faye server.

var faye  = require('faye'),
    redis = require('faye-redis'),
    http  = require('http');

var server = http.createServer();

var bayeux = new faye.NodeAdapter({
  mount:    '/',
  timeout:  25,
  engine: {
    type:   redis,
    host:   'redis.example.com',
    // more options
  }
});

bayeux.attach(server);
server.listen(8000);

The full list of settings is as follows.

  • host - hostname of your Redis instance
  • port - port number, default is 6379
  • password - password, if requirepass is set
  • database - number of database to use, default is 0
  • namespace - prefix applied to all keys, default is ''
  • socket - path to Unix socket if unixsocket is set

Development

To run the tests, first start up a local Redis server running on port 16379.

$ redis-server spec/redis.conf
$ node spec/runner.js

This engine does have some incompatibilities with the spec, and currently there are four known test failures:

  1. Redis engine destroyClient when the client has subscriptions stops the client receiving messages:
  2. Redis engine publish with a single wildcard delivers messages to matching subscriptions:
  3. Redis engine publish with a double wildcard delivers a unique copy of the message to each client:
  4. Redis engine publish with a double wildcard delivers messages to matching subscriptions:

License

(The MIT License)

Copyright (c) 2011-2012 James Coglan

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.