Edit Page
sails.sockets.emit()
This method is deprecated. Call
.broadcast()instead, using the desired socket id(s) as room names.
Purpose
Send a message to one or more sockets by id.
Overview
Parameters
| Description | Accepted Data Types | Required ? | |
|---|---|---|---|
| 1 | IDs of sockets to receive message | string, array |
Yes |
| 2 | Event name | string |
No |
| 3 | Message data | object |
Yes |
Example Usage
// Controller action
sayHiToFriend: function(req, res) {
var friendId = req.param('friendId');
sails.sockets.emit(friendId, 'privateMessage', {from: req.session.userId, msg: 'Hi!'});
res.json({
message: 'Message sent!'
});
}
Notes
- If the event name is not specified then the "message" event will be used by default. That means that target sockets listening for the
messageevent in client-side code (e.g.io.socket.on('message', function (data){ /* ... */ })) will have that event handler triggered.- If any of the target socket ids are unknown, an error is thrown (this error has a
codeproperty equal toSAILS:HOOK:SOCKETS:NO_SUCH_SOCKET).
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.