docs/reference/websockets/sails.sockets/sails.sockets.blast.md
.blast()Broadcast a message to all sockets connected to the server (or any server in the cluster, if you have a multi-server deployment using Redis).
sails.sockets.blast(data);
or:
sails.sockets.blast(eventName, data);sails.sockets.blast(data, socketToOmit);sails.sockets.blast(eventName, data, socketToOmit);| Argument | Type | Details | |
|---|---|---|---|
| 1 | eventName | ((string?)) | Optional. Defaults to 'message'. |
| 2 | data | ((json)) | The data to send in the message. |
| 3 | socketToOmit | ((req?)) | Optional. If provided, the socket associated with this socket request will not receive the message blasted out to everyone else. Useful when the broadcast-worthy event is triggered by a requesting user who doesn't need to hear about it again. |
In a controller action...
sails.sockets.blast('user_logged_in', {
msg: 'User #' + user.id + ' just logged in.',
user: {
id: user.id,
username: user.username
}
}, req);
<docmeta name="displayName" value=".blast()"> <docmeta name="pageType" value="method">
- Be sure to check that
req.isSocket === truebefore passing inreqto this method. For the socket to be omitted, the currentreqmust be from a socket request, not just any HTTP request.