.leave()
Unsubscribe a socket from a room.
sails.sockets.leave(socket, roomName);
or:
sails.sockets.leave(socket, roomName, cb);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | socket | The socket to be unsubscribed. May be either the incoming socket request (req) or the ID of another socket. | |
| 2 | roomName | The name of the room to which the socket will be unsubscribed. | |
| 3 | _cb_ | An optional callback, which will be called when the operation is complete on the current server (see notes below for more information), or if fatal errors were encountered. In the case of errors, it will be called with a single argument (err). |
Example
In a controller action, unsubscribe the requesting socket from the specified room:
leaveFunRoom: function(req, res) {
if ( _.isUndefined(req.param('roomName')) ) {
return res.badRequest('`roomName` is required.');
}
if (!req.isSocket) {
return res.badRequest('This endpoints only supports socket requests.');
}
var roomName = req.param('roomName');
sails.sockets.leave(req, roomName, function(err) {
if (err) {return res.serverError(err);}
return res.json({
message: 'Left a fun room called '+roomName+'!'
});
});
}
Additional Examples
More examples of sails.sockets.leave() usage are available here, including unsubscribing other sockets by ID, deeper integration with the database, usage within a service, and usage with the async library.
Notes
sails.sockets.leave()is more or less equivalent to the functionality of.leave()in Socket.IO, but with additional built-in support for multi-server deployments. With recommended production settings,sails.sockets.leave()works as documented no matter what server the code happens to be running on or the server to which the target socket is connected.- In a multi-server environment, when calling
.leave()with a socket ID argument, the callback function (cb) will be executed when the.leave()call completes on the current server. This does not guarantee that other servers in the cluster have already finished running the operation.- Be sure to check that
req.isSocket === truebefore passing inreqas the socket to be unsubscribed. For that to work, the providedreqmust be from a socket request, not just any old HTTP request.
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.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- 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.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop 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-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.