neoziro

dolmac

jsfez

ludowic

mbar

sachamorard

primus-cluster

var socketKey = require('./keys/socket');

Adapter.prototype.add = function add(id, room, cb) {

    .expire(socketKey.format(id), this.ttl)

    .expire(roomKey.format(room), this.ttl);

Adapter.prototype.get = function get(id, cb) {

  this.client.smembers(socketKey.format(id), cb);

 * Removes a socket from a room or from all rooms

 * @param {String|Function} [room] The room name or callback

Adapter.prototype.del = function del(id, room, cb) {

  if (! cb) return this.delAll(id, room);

 *  - `except` {Array} sids that should be excluded

 *  - `rooms` {Array} list of rooms to broadcast to

 *  - `method` {String} 'write' or 'send' if primus-emitter is present

 * @param {Object} clients Connected clients

Adapter.prototype.broadcast = function broadcast(data, opts, clients, cb) {

  var rooms = opts.rooms = opts.rooms || [];

  var except = opts.except = opts.except || [];

  var method = opts.method = opts.method || 'write';

      multi.smembers(roomKey.format(room));

      replies.forEach(function (roomIds) {

          if (ids[id] || except.indexOf(id) !== -1) return;

          clients[id][method].apply(clients[id], data);

    this.client.keys('socket:*', function (err, sockets) {

      var ids = sockets.map(socketKey.parse);

        if (except.indexOf(id) !== -1) return;

        clients[id][method].apply(clients[id], data);

 * Get client ids connected to this room.

Adapter.prototype.clients = function clients(room, cb) {

  this.client.smembers(roomKey.format(room), cb);

Adapter.prototype.empty = function empty(room, cb) {

  this.client.del(roomKey.format(room), cb);

  "description": "Scale Primus across multiple servers.",

    "url": "https://github.com/neoziro/primus-cluster.git"

# primus-cluster [![Build Status](https://travis-ci.org/neoziro/primus-cluster.png)](https://travis-ci.org/neoziro/primus-cluster)

Primus cluster runs Primus accross multiple servers, it use Redis to store data and distribute messages across Primus instances. For more informations you can see [Redis Pub/Sub](http://redis.io/topics/pubsub).

This project is a fork of the original project [primus-redis](https://github.com/mmalecki/primus-redis) that

is not compatible with other Primus plugins and with Primus v2+.

This plugin works with [primus-emitter](https://github.com/cayasso/primus-emitter/), [primus-rooms](https://github.com/cayasso/primus-rooms/), and [primus-resource](https://github.com/cayasso/primus-resource/).

var PrimusCluster = require('primus-cluster');

If you specify an **object**, the properties will be used to call `redis.createClient` method. The redis module used

will be the Redis module installed. This project doesn't have [node_redis](https://github.com/mranney/node_redis/) module as dependency.

If you specify a **function**, it will be called to create redis clients.

  client.select(1); // Choose a custom database.

The name of the channel to use, the default channel is "primus".

The TTL of the data stored in redis in second, the default value is 86400 (1 day). If you use [primus-rooms](https://github.com/cayasso/primus-rooms/), Primus cluster will store rooms data in redis.

When you use primus-redis with other plugins, you must take care of calling primus-cluster after all plugins.

var expect = require('chai').use(require('sinon-chai')).expect;

    it('should add a socket into a room', function (done) {

      adapter.add('12', 'my:room:name', function (err) {

        .sismember('socket:12', 'my:room:name')

        .sismember('room:my:room:name', '12')

          expect(replies[0]).to.equal(1);

          expect(replies[1]).to.equal(1);

    it('should add a socket into a room with correct expire', function (done) {

          expect(replies[0]).to.be.most(30);

          expect(replies[1]).to.be.most(30);

        adapter.add.bind(adapter, '12', 'my:room:name'),

        adapter.add.bind(adapter, '12', 'my:second:room:name')

    it('should return client rooms', function (done) {

      adapter.get('12', function (err, rooms) {

        expect(rooms).to.have.members(['my:room:name', 'my:second:room:name']);

    it('should remove client from a room', function (done) {

      adapter.del('12', 'my:room:name', function (err) {

        .sismember('socket:12', 'my:second:room:name')

        .sismember('room:my:second:room:name', '12')

          expect(replies[0]).to.equal(0);

          expect(replies[1]).to.equal(0);

          expect(replies[2]).to.equal(1);

          expect(replies[3]).to.equal(1);

    it('should remove client from all room if called without room', function (done) {

      adapter.del('12', null, function (err) {

          expect(replies[2]).to.equal(0);

          expect(replies[3]).to.equal(0);

        adapter.add.bind(adapter, '13', 'my:room:name')

    it('should return clients', function (done) {

      adapter.clients('my:room:name', function (err, ids) {

        expect(ids).to.have.members(['12', '13']);

        adapter.add.bind(adapter, 'marc', 'news'),

        adapter.add.bind(adapter, 'jose', 'sport'),

        adapter.add.bind(adapter, 'jose', 'news'),

        adapter.add.bind(adapter, 'greg', 'news'),

        adapter.add.bind(adapter, 'vincent', 'sport'),

        adapter.add.bind(adapter, 'ludowic', 'sport'),

        adapter.add.bind(adapter, 'ludowic', 'news'),

        adapter.add.bind(adapter, 'samuel', 'geek')

    it('should broadcast to all clients', function (done) {

      adapter.broadcast(data, {}, clients, function (err) {

        Object.keys(clients).forEach(function (id) {

          expect(socket.write).to.be.calledOnce;

    it('should broadcast to a specific room', function (done) {

      adapter.broadcast(data, { rooms: ['sport', 'geek'] }, clients, function (err) {

        expect(clients.marc.write).to.not.be.called;

        expect(clients.jose.write).to.be.calledOnce;

        expect(clients.greg.write).to.not.be.called;

        expect(clients.vincent.write).to.be.calledOnce;

        expect(clients.ludowic.write).to.be.calledOnce;

        expect(clients.samuel.write).to.be.calledOnce;

    it('should not send to excepted clients (with rooms)', function (done) {

      adapter.broadcast(data, { rooms: ['sport', 'geek'], except: ['jose'] }, clients, function (err) {

        expect(clients.jose.write).to.not.be.called;

		@@ -75,3 +75,3 @@ /**
		Adapter.prototype.del = function del(id, room, cb) {
		if (! cb) return this.delAll(id, room);
		if (!room) return this.delAll(id, cb);

		@@ -78,0 +78,0 @@ cb = cb \|\| noop;

		{
		"name": "primus-cluster",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "Scale Primus across multiple servers.",
		@@ -32,2 +32,2 @@ "dependencies": {
		"license": "MIT"
		}
		}

		@@ -98,3 +98,3 @@ # primus-cluster [![Build Status](https://travis-ci.org/neoziro/primus-cluster.png)](https://travis-ci.org/neoziro/primus-cluster)
		primus.use('rooms', PrimusRooms);
		primus.use('rooms', PrimusEmitter);
		primus.use('emitter', PrimusEmitter);
		primus.use('cluster', PrimusCluster);
		@@ -105,2 +105,2 @@ ```

		MIT
		MIT

		@@ -103,3 +103,3 @@ var redis = require('redis');
		it('should remove client from all room if called without room', function (done) {
		adapter.del('12', function (err) {
		adapter.del('12', null, function (err) {
		if (err) return done(err);
		@@ -106,0 +106,0 @@ client.multi()

Improved metrics