primus-rooms-redis-adapter


Redis adapter for primus-rooms.
Provides integration with metroplex and omega-supreme to allow for multiple servers support.

Installation

``
$ npm install primus-rooms-redis-adapter --save
`

Getting started

The adapter relies on ioredis for the redis connection, if an incorrect instance is provided the adapter will throw an error

`javascript
'use strict';

var Primus = require('primus');
var Redis = require('ioredis');
var Adapter = require('primus-rooms-redis-adapter');

var redis = new Redis(/ options /);
var adapter = new Adapter(redis, {/ options /});
`

Once the adapter has been initialized it can be used to initialize the primus-rooms plugin.
`javascript
// as an argument
var primus = new Primus(http, {
transformer: 'websockets',
rooms: {adapter: adapter},
plugin: {
'rooms': require('primus-rooms'),
},
});

// or by setting the property
primus.adapter = new Adapter();
`

Metroplex and Omega-Supreme Integration

`javascript
var options = {
metroplexOmegaSupreme: true,
primus: primus,
};

adapter.config(options, function(){
console.log('clean exit');
});
// or
primus.adapter.config(options);
`

API

$3

Name | Type | Description | Default
-----------------------|----------|-------------------------------------------|---------------
namespace | String | namespace to use in redis storage | bumblebee
metroplexOmegaSupreme | Boolean | Use omega-supreme to broadcast to all servers through metroplex | false

$3

Note: Preforming cleanExit can take a while especially if the http server timeout is set too high.
The reason for that is due to node design, see issue #2642.
I recommend setting http server timeout to based on the server load higher load longer time to finish up
sending data to the user. To set the time out use require('http').createServer().setTimeout(x); where x
is the timeout duration you want to allow a keep-alive request to be in idle before terminating it.

Name | Type |Description | Default
-----------------------|----------|-------------------------------------------|---------------
metroplexOmegaSupreme | Boolean | Use omega-supreme to broadcast to all servers through metroplex | initilized value
primus | Object | Primus instance to be used to preform clean exit| undefined
cb | Function | Callback function after a clean exit is preformed | undefined`