Edit Page

.join()

Subscribe a socket to a room.

sails.sockets.join(socket, roomName);

Or:

sails.sockets.join(socket, roomName, cb);

Usage

	Argument	Type	Details
1	`socket`	,	The socket to be subscribed. May be specified by the socket's id or an incoming socket request (`req`).
2	`roomName`		The name of the room to which the socket will be subscribed. If the room does not exist yet, it will be created.
3	`cb`		An optional callback which will be called when the operation is complete on the current server (see notes below for more information), or if fatal errors were encountered. In the case of errors, it will be called with a single argument (`err`).

Example

In a controller action:

subscribeToFunRoom: function(req, res) {
  if (!req.isSocket) {
    return res.badRequest();
  }

  var roomName = req.param('roomName');
  sails.sockets.join(req, roomName, function(err) {
    if (err) {
      return res.serverError(err);
    }

    return res.json({
      message: 'Subscribed to a fun room called '+roomName+'!'
    });
  });
}

Notes

sails.sockets.join() is more or less equivalent to the functionality of .join() in Socket.io, but with additional built-in support for multi-server deployments. With recommended production settings, sails.sockets.join() works as documented no matter what server the code happens to be running on, or the server the target socket is connected to.

In a multi-server environment, when calling .join() with a socket ID argument, the callback function (cb) will be executed when the .join() call completes on the current server. This does not guarantee that other servers in the cluster have already finished running the operation.

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 and check req.isSocket === true before passing in req as the target socket. For that to work, the provided req must be from a socket request, not just any old 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-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Documentation

Reference

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!