socket.io-ioredis

1.4.1 • Public • Published

socket.io-ioredis

How to use

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

By running socket.io with the socket.io-ioredis 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.

API

adapter(uri[, opts])

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

adapter(opts)

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 ioredis as a client.

RedisAdapter

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(){});

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i socket.io-ioredis

Weekly Downloads

180

Version

1.4.1

License

MIT

Last publish

Collaborators

  • fracmak