[![Build Status](https://travis-ci.org/Automattic/socket.io-redis.svg?branch=master)](https://travis-ci.org/Automattic/socket.io-redis) [![NPM version](https://badge.fury.io/js/socket.io-redis.svg)](http://badge.fury.io/js/socket.io-redis)
Last updated 5 years ago by flat .
Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @flat/socket.io-redis 
SYNC missed versions from official npm registry.


Build Status NPM version

How to use

var io = require('socket.io')(3000);
var redis = require('socket.io-redis');
io.adapter(redis({ host: 'localhost', port: 6379 }));

By running socket.io with the socket.io-redis adapter you can run multiple socket.io instances in different processes or servers that can all broadcast and emit events to and from each other.

If you need to emit events to socket.io instances from a non-socket.io process, you should use socket.io-emitter.


adapter(uri[, opts])

uri is a string like localhost:6379 where your redis server is located. For a list of options see below.


The following options are allowed:

  • key: the name of the key to pub/sub events on as prefix (socket.io)
  • host: host to connect to redis on (localhost)
  • port: port to connect to redis on (6379)
  • pubClient: optional, the redis client to publish events on
  • subClient: optional, the redis client to subscribe to events on

If you decide to supply pubClient and subClient, make sure you use node_redis as a client or one with an equivalent API.

If you supply clients, make sure you initialized them with the return_buffers option set to true.


The redis adapter instances expose the following properties that a regular Adapter does not

  • uid
  • prefix
  • pubClient
  • subClient

Client error handling

Access the pubClient and subClient properties of the Redis Adapter instance to subscribe to its error event:

var redis = require('socket.io-redis');
var adapter = adapter('localhost:6379');
adapter.pubClient.on('error', function(){});
adapter.subClient.on('error', function(){});

Custom client (eg: with authentication)

If you need to create a redisAdapter to a redis instance that has a password, use pub/sub options instead of passing a connection string.

var redis = require('redis').createClient;
var adapter = require('socket.io-redis');
var pub = redis(port, host, { auth_pass: "pwd" });
var sub = redis(port, host, { detect_buffers: true, auth_pass: "pwd" });
io.adapter(adapter({ pubClient: pub, subClient: sub }));

Make sure the detect_buffers option is set to true for the sub client.



Current Tags

  • 0.1.4                                ...           latest (5 years ago)

1 Versions

  • 0.1.4                                ...           5 years ago
Maintainers (1)
Today 0
This Week 0
This Month 3
Last Day 0
Last Week 2
Last Month 1
Dependencies (6)
Dev Dependencies (4)
Dependents (0)

Copyright 2014 - 2017 © taobao.org |