.travis.yml

@@ -1,12 +1,11 @@
 language: node_js
 sudo: false
 node_js:
-  - "0.10"
-  - "0.12"
-  - "4"
-  - "6"
-  - "node"
+  - "8"
+  - "10"
+  - "12"
+  - "13"
 notifications:
   irc: "irc.freenode.org#socket.io"
 services:
-  - redis-server
+  - redis

CHANGELOG.md

@@ -0,0 +1,30 @@
+# [5.3.0](https://github.com/socketio/socket.io-redis/compare/5.2.0...5.3.0) (2020-06-04)
+
+
+### Features
+
+* add support for Redis Cluster ([7a19075](https://github.com/socketio/socket.io-redis/commit/7a190755c01732d1335199732e7b0eb5a1fb1f9e))
+
+
+
+# [5.2.0](https://github.com/socketio/socket.io-redis/compare/5.1.0...5.2.0) (2017-08-24)
+
+
+### Features
+
+* increase default requestsTimeout to 5000 ms ([37e28df](https://github.com/socketio/socket.io-redis/commit/37e28df54b0b8c71b4f8ea1766e56dc63fb26ba2))
+
+
+
+# [5.1.0](https://github.com/socketio/socket.io-redis/compare/5.0.1...5.1.0) (2017-06-04)
+
+### Bug Fixes
+
+* use the requestid from response when deleting requests ([4f08b1a](https://github.com/socketio/socket.io-redis/commit/4f08b1ae7b3b9ee549349f1b95f5e3f3ff69d651))
+
+
+### Features
+
+* add support for ArrayBuffer ([b3ad4ad](https://github.com/socketio/socket.io-redis/commit/b3ad4ad28b225f1999d5dd709f2ea6d5674085f6))
+
+

README.md

@@ -6,15 +6,29 @@
 ## How to use
 
 ```js
-var io = require('socket.io')(3000);
-var redis = require('socket.io-redis');
-io.adapter(redis({ host: 'localhost', port: 6379 }));
+const io = require('socket.io')(3000);
+const redisAdapter = require('socket.io-redis');
+io.adapter(redisAdapter({ 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.
 
+So any of the following commands:
+
+```js
+io.emit('hello', 'to all clients');
+io.to('room42').emit('hello', "to all clients in 'room42' room");
+
+io.on('connection', (socket) => {
+  socket.broadcast.emit('hello', 'to all clients except sender');
+  socket.to('room42').emit('hello', "to all clients in 'room42' room except sender");
+});
+```
+
+will properly be broadcast to the clients through the Redis Pub/Sub mechanism.
+
 If you need to emit events to socket.io instances from a non-socket.io
 process, you should use [socket.io-emitter](https://github.com/socketio/socket.io-emitter).
 
@@ -32,11 +46,9 @@ 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`)
-- `subEvent`: optional, the redis client event name to subscribe to (`messageBuffer`)
 - `pubClient`: optional, the redis client to publish events on
 - `subClient`: optional, the redis client to subscribe to events on
-- `requestsTimeout`: optional, after this timeout the adapter will stop waiting from responses to request (`1000ms`)
-- `withChannelMultiplexing`: optional, whether channel multiplexing is enabled (a new subscription will be trigggered for each room) (`true`)
+- `requestsTimeout`: optional, after this timeout the adapter will stop waiting from responses to request (`5000ms`)
 
 If you decide to supply `pubClient` and `subClient`, make sure you use
 [node_redis](https://github.com/mranney/node_redis) as a client or one
@@ -58,21 +70,27 @@ that a regular `Adapter` does not
 Returns the list of client IDs connected to `rooms` across all nodes. See [Namespace#clients(fn:Function)](https://github.com/socketio/socket.io#namespaceclientsfnfunction)
 
 ```js
-io.adapter.clients(function (err, clients) {
+io.of('/').adapter.clients((err, clients) => {
   console.log(clients); // an array containing all connected socket ids
 });
 
-io.adapter.clients(['room1', 'room2'], function (err, clients) {
+io.of('/').adapter.clients(['room1', 'room2'], (err, clients) => {
   console.log(clients); // an array containing socket ids in 'room1' and/or 'room2'
 });
+
+// you can also use
+
+io.in('room3').clients((err, clients) => {
+  console.log(clients); // an array containing socket ids in 'room3'
+});
 ```
 
 ### RedisAdapter#clientRooms(id:String, fn:Function)
 
 Returns the list of rooms the client with the given ID has joined (even on another node).
 
 ```js
-io.adapter.clientRooms('<my-id>', function (err, rooms) {
+io.of('/').adapter.clientRooms('<my-id>', (err, rooms) => {
   if (err) { /* unknown id */ }
   console.log(rooms); // an array containing every room a given id has joined.
 });
@@ -83,7 +101,7 @@ io.adapter.clientRooms('<my-id>', function (err, rooms) {
 Returns the list of all rooms.
 
 ```js
-io.adapter.allRooms(function (err, rooms) {
+io.of('/').adapter.allRooms((err, rooms) => {
   console.log(rooms); // an array containing all rooms (accross every node)
 });
 ```
@@ -93,7 +111,7 @@ io.adapter.allRooms(function (err, rooms) {
 Makes the socket with the given id join the room. The callback will be called once the socket has joined the room, or with an `err` argument if the socket was not found.
 
 ```js
-io.adapter.remoteJoin('<my-id>', 'room1', function (err) {
+io.of('/').adapter.remoteJoin('<my-id>', 'room1', (err) => {
   if (err) { /* unknown id */ }
   // success
 });
@@ -104,7 +122,7 @@ io.adapter.remoteJoin('<my-id>', 'room1', function (err) {
 Makes the socket with the given id leave the room. The callback will be called once the socket has left the room, or with an `err` argument if the socket was not found.
 
 ```js
-io.adapter.remoteLeave('<my-id>', 'room1', function (err) {
+io.of('/').adapter.remoteLeave('<my-id>', 'room1', (err) => {
   if (err) { /* unknown id */ }
   // success
 });
@@ -115,7 +133,7 @@ io.adapter.remoteLeave('<my-id>', 'room1', function (err) {
 Makes the socket with the given id to get disconnected. If `close` is set to true, it also closes the underlying socket. The callback will be called once the socket was disconnected, or with an `err` argument if the socket was not found.
 
 ```js
-io.adapter.remoteDisconnect('<my-id>', true, function (err) {
+io.of('/').adapter.remoteDisconnect('<my-id>', true, (err) => {
   if (err) { /* unknown id */ }
   // success
 });
@@ -127,12 +145,12 @@ Sends a request to every nodes, that will respond through the `customHook` metho
 
 ```js
 // on every node
-io.adapter.customHook = function (data) {
-  return 'hello ' + data;
+io.of('/').adapter.customHook = (data, cb) => {
+  cb('hello ' + data);
 }
 
 // then
-io.adapter.customRequest('john', function(err, replies){
+io.of('/').adapter.customRequest('john', function(err, replies){
   console.log(replies); // an array ['hello john', ...] with one element per node
 });
 ```
@@ -143,8 +161,7 @@ Access the `pubClient` and `subClient` properties of the
 Redis Adapter instance to subscribe to its `error` event:
 
 ```js
-var redis = require('socket.io-redis');
-var adapter = redis('localhost:6379');
+const adapter = require('socket.io-redis')('localhost:6379');
 adapter.pubClient.on('error', function(){});
 adapter.subClient.on('error', function(){});
 ```
@@ -153,9 +170,9 @@ The errors emitted from `pubClient` and `subClient` will
 also be forwarded to the adapter instance:
 
 ```js
-var io = require('socket.io')(3000);
-var redis = require('socket.io-redis');
-io.adapter(redis({ host: 'localhost', port: 6379 }));
+const io = require('socket.io')(3000);
+const redisAdapter = require('socket.io-redis');
+io.adapter(redisAdapter({ host: 'localhost', port: 6379 }));
 io.of('/').adapter.on('error', function(){});
 ```
 
@@ -166,11 +183,58 @@ that has a password, use pub/sub options instead of passing
 a connection string.
 
 ```js
-var redis = require('redis').createClient;
-var adapter = require('socket.io-redis');
-var pub = redis(port, host, { auth_pass: "pwd" });
-var sub = redis(port, host, { auth_pass: "pwd" });
-io.adapter(adapter({ pubClient: pub, subClient: sub }));
+const redis = require('redis');
+const redisAdapter = require('socket.io-redis');
+const pub = redis.createClient(port, host, { auth_pass: "pwd" });
+const sub = redis.createClient(port, host, { auth_pass: "pwd" });
+io.adapter(redisAdapter({ pubClient: pub, subClient: sub }));
+```
+
+## With [ioredis](https://github.com/luin/ioredis) client
+
+### Cluster example
+
+```js
+const io = require('socket.io')(3000);
+const redisAdapter = require('socket.io-redis');
+const Redis = require('ioredis');
+
+const startupNodes = [
+  {
+    port: 6380,
+    host: '127.0.0.1'
+  },
+  {
+    port: 6381,
+    host: '127.0.0.1'
+  }
+];
+
+io.adapter(redisAdapter({
+  pubClient: new Redis.Cluster(startupNodes),
+  subClient: new Redis.Cluster(startupNodes)
+}));
+```
+
+### Sentinel Example
+
+```js
+const io = require('socket.io')(3000);
+const redisAdapter = require('socket.io-redis');
+const Redis = require('ioredis');
+
+const options = {
+  sentinels: [
+    { host: 'somehost1', port: 26379 },
+    { host: 'somehost2', port: 26379 }
+  ],
+  name: 'master01'
+};
+
+io.adapter(redisAdapter({
+  pubClient: new Redis(options),
+  subClient: new Redis(options)
+}));
 ```
 
 ## Protocol
@@ -194,7 +258,7 @@ A number of other libraries adopt this protocol including:
 
 - [socket.io-emitter](https://github.com/socketio/socket.io-emitter)
 - [socket.io-python-emitter](https://github.com/GameXG/socket.io-python-emitter)
-
+- [socket.io-emitter-go](https://github.com/stackcats/socket.io-emitter-go)
 
 ## License
 

docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2.0'
+services:
+  redis:
+    image: redis:5
+    ports:
+      - "6379:6379"