.broadcast()
Broadcast a message to all sockets in a room (or to a particular socket).
sails.sockets.broadcast(roomNames, data);
Or:
sails.sockets.broadcast(roomNames, eventName, data);sails.sockets.broadcast(roomNames, data, socketToOmit);sails.sockets.broadcast(roomNames, eventName, data, socketToOmit);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | roomNames | The name of one or more rooms in which to broadcast a message (see sails.sockets.join). To broadcast to individual sockets, use their IDs as room names. | |
| 2 | eventName | Optional. The unique name of the event used by the client to identify this message. Defaults to 'message'. |
|
| 3 | data | The data to send in the message. | |
| 4 | socketToOmit | Optional. If provided, the socket belonging to the specified socket request will not receive the message. This is useful if you trigger the broadcast from a client, but don't want that client to receive the message itself (for example, sending a message to everybody else in a chat room). |
Example
In an action, service, or arbitrary script on the server:
sails.sockets.broadcast('artsAndEntertainment', { greeting: 'Hola!' });
On the client:
io.socket.on('message', function (data){
console.log(data.greeting);
});
Additional Examples
More examples of sails.sockets.brodcast() usage are available here, including broadcasting to multiple rooms, using a custom event name, and omitting the requesting socket.
Notes
sails.sockets.broadcast()is more or less equivalent to the functionality of.emit()and.broadcast()in Socket.IO.- Every socket is automatically subscribed to a room with its ID as the name, allowing direct messaging to a socket via
sails.sockets.broadcast()- Be sure to check that
req.isSocket === truebefore passing inreqassocketToOmit. For the requesting socket to be omitted, the request (req) must be from a socket request, not just any old HTTP request.datamust be JSON-serializable; i.e. it's best to use plain dictionaries/arrays, and make sure your data does not contain any circular references. If you aren't sure, build your broadcastdatamanually, or call something likerttc.dehydrate(data,true,true)on it first.
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.