View our GitHub

Please visit sails-docs on GitHub to view documentation on your mobile device.

Edit Page

sails.sockets.broadcast( roomName, [event], data, [socketToOmit] )

Broadcast a message to a room.

sails.sockets.broadcast(roomName, data);

Or:

  • sails.sockets.broadcast(roomName, eventName, data);
  • sails.sockets.broadcast(roomName, data, socketToOmit);
  • sails.sockets.broadcast(roomName, eventName, data, socketToOmit);

Usage

Argument Type Details
1 roomName The room to broadcast a message in (see sails.sockets.join)
2 eventName Optional. Defaults to 'message'.
3 data The data to send in the message.
4 socketToOmit Optional. If provided, that socket 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

sails.sockets.broadcast('artsAndEntertainment', { msg: 'Hi there!' });

Notes

  • The phrase "request socket" here refers to an application-layer WebSocket/Socket.io connection. req.socket also exists for HTTP requests, but it refers to the underlying TCP socket at the transport layer, which is different. Be sure and ensure req.isSocket == true before using req.socket with this method.

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-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Reference

We wrote a book!

Get early access to the book
with promotion code: mcneildoc

Get the Book