sails.sockets.subscribers()
This method is deprecated.
If you absolutely need to retrieve the list of socket IDs in a room, you may use the lower-level
sails.io.sockets.in(roomName).clients(cb)method (see https://github.com/socketio/socket.io/#namespaceclientsfnfunction).However, be aware that in multi-server scenarios, that method will not return IDs of sockets on other servers (at the time of writing, the current documentation on Socket.io's GitHub is out of date on that point).
For the most common use-case of "taking all members of room A and subscribing/unsubscribing them to room B", you can use the
sails.sockets.addRoomMembersToRoomsandsails.sockets.removeRoomMembersFromRoomsmethods, which do work cross-server.
Get the IDs of all sockets subscribed to a room.
sails.sockets.subscribers(roomName, cb);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | roomName | The name of the room whose socket IDs should be retrieved. e.g. 'supportchat'. |
|
| 2 | cb | Function to be called when the socket IDs have been retrieved. The function should have two arguments: err and socketIds. |
Example
sails.sockets.subscribers('supportchat', function(err, socketIds) {
console.log(socketIds);
});
// => ['BetX2G-2889Bg22xi-jy', 'BTA4G-8126Kr32bi-za']
Notes
This method currently only operates on a single server. If your Sails app is distributed over multiple servers (for example by using the
socket.io-redisadapter), calling.subscribers(roomName, cb)will only retrieve the socket IDs of subscribers toroomNamethat are connected to the server making the call.
// Controller action
getRoomSubscribers: function(req, res) {
if (!req.isSocket) return res.badRequest();
if (!req.param('room')) return res.badRequest('No room specified- please specify the name of the room whose subscribers you want to look up.');
var subscribers = sails.sockets.subscribers(room); return res.ok(require('util').format( 'The "%s" room currently has %d subscribers: ', req.param('room'), subscribers.length, subscribers )); } ``` -->
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command Line Interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.