Edit Page

.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:

Usage

#
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.

Example

#

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);

Notes

#
  • Be sure to check that req.isSocket === true before passing in req to this method. For the socket to be omitted, the current req must be from a socket request, not just any HTTP request.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Reference

Reference