faye-ioredis

This plugin provides an 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.

It uses the ioredis client and supports Redis Cluster and Sentinel.

Usage

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

1var faye        = require('faye');
2var fayeIoRedis = require('faye-ioredis');
3var http        = require('http');
4
5var server = http.createServer();
6
7var bayeux = new faye.NodeAdapter({
8  mount:    '/',
9  timeout:  25,
10  engine: {
11    type: fayeIoRedis,
12    redisConnectionOptions: {  // See https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new
13      port: 6379,              // Redis port
14      host: '127.0.0.1',       // Redis host
15    }
16  }
17});
18
19bayeux.attach(server);
20server.listen(8000);

Cluster Support

To use Redis Cluster support, use the redisClass option along-side redisConnectionOptions, like so:

1var faye        = require('faye');
2var fayeIoRedis = require('faye-ioredis');
3var Redis       = require('ioredis');
4var http        = require('http');
5
6var server = http.createServer();
7
8var bayeux = new faye.NodeAdapter({
9  mount:    '/',
10  timeout:  25,
11  engine: {
12    type: fayeIoRedis,
13    redisClass: Redis.Cluster, // Use Clustering
14    redisConnectionOptions: [{ // See https://github.com/luin/ioredis/blob/master/API.md#new-clusterstartupnodes-options
15      port: 7000,
16      host: '127.0.0.1'
17    }, {
18      port: 7001,
19      host: '127.0.0.1'
20    }],
21
22  }
23});
24
25bayeux.attach(server);
26server.listen(8000);

License

(The MIT License)

Copyright (c) 2011-2013 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.