Edit Page
.getId()
Parse the socket ID from an incoming socket request (req).
sails.sockets.getId(req);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | req | A socket request (req). |
Once acquired, the socket object's ID can be used to send direct messages to that socket (see sails.sockets.broadcast).
Example
// Controller action
getSocketID: function(req, res) {
if (!req.isSocket) {
return res.badRequest();
}
var socketId = sails.sockets.getId(req);
// => "BetX2G-2889Bg22xi-jy"
sails.log('My socket ID is: ' + socketId);
return res.json(socketId);
}
Notes
- Be sure to check that
req.isSocket === truebefore passing inreq. This method does not work for HTTP requests!
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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.