![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
socket.io-redis
Advanced tools
Readme
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.
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 onsubClient
: optional, the redis client to subscribe to events onrequestsTimeout
: optional, after this timeout the adapter will stop waiting from responses to request (1000ms
)If you decide to supply pubClient
and subClient
, make sure you use
node_redis as a client or one
with an equivalent API.
The redis adapter instances expose the following properties
that a regular Adapter
does not
uid
prefix
pubClient
subClient
requestsTimeout
Returns the list of client IDs connected to rooms
across all nodes. See Namespace#clients(fn:Function)
io.of('/').adapter.clients(function (err, clients) {
console.log(clients); // an array containing all connected socket ids
});
io.of('/').adapter.clients(['room1', 'room2'], function (err, clients) {
console.log(clients); // an array containing socket ids in 'room1' and/or 'room2'
});
// you can also use
io.in('room3').clients(function (err, clients) {
console.log(clients); // an array containing socket ids in 'room3'
});
Returns the list of rooms the client with the given ID has joined (even on another node).
io.of('/').adapter.clientRooms('<my-id>', function (err, rooms) {
if (err) { /* unknown id */ }
console.log(rooms); // an array containing every room a given id has joined.
});
Returns the list of all rooms.
io.of('/').adapter.allRooms(function (err, rooms) {
console.log(rooms); // an array containing all rooms (accross every node)
});
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.
io.of('/').adapter.remoteJoin('<my-id>', 'room1', function (err) {
if (err) { /* unknown id */ }
// success
});
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.
io.of('/').adapter.remoteLeave('<my-id>', 'room1', function (err) {
if (err) { /* unknown id */ }
// success
});
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.
io.of('/').adapter.remoteDisconnect('<my-id>', true, function (err) {
if (err) { /* unknown id */ }
// success
});
Sends a request to every nodes, that will respond through the customHook
method.
// on every node
io.of('/').adapter.customHook = function (data, cb) {
cb('hello ' + data);
}
// then
io.of('/').adapter.customRequest('john', function(err, replies){
console.log(replies); // an array ['hello john', ...] with one element per node
});
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 = redis('localhost:6379');
adapter.pubClient.on('error', function(){});
adapter.subClient.on('error', function(){});
The errors emitted from pubClient
and subClient
will
also be forwarded to the adapter instance:
var io = require('socket.io')(3000);
var redis = require('socket.io-redis');
io.adapter(redis({ host: 'localhost', port: 6379 }));
io.of('/').adapter.on('error', function(){});
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, { auth_pass: "pwd" });
io.adapter(adapter({ pubClient: pub, subClient: sub }));
The socket.io-redis
adapter broadcasts and receives messages on particularly named Redis channels. For global broadcasts the channel name is:
prefix + '#' + namespace + '#'
In broadcasting to a single room the channel name is:
prefix + '#' + namespace + '#' + room + '#'
prefix
: The base channel name. Default value is socket.io
. Changed by setting opts.key
in adapter(opts)
constructornamespace
: See https://github.com/socketio/socket.io#namespace.room
: Used if targeting a specific room.A number of other libraries adopt this protocol including:
MIT
FAQs
[![Build Status](https://github.com/socketio/socket.io-redis/workflows/CI/badge.svg?branch=master)](https://github.com/socketio/socket.io-redis/actions) [![NPM version](https://badge.fury.io/js/socket.io-redis.svg)](http://badge.fury.io/js/socket.io-redis
The npm package socket.io-redis receives a total of 77,362 weekly downloads. As such, socket.io-redis popularity was classified as popular.
We found that socket.io-redis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.