View our GitHub

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

Edit Page

sails.sockets.leave( socket, roomName )

Purpose

Unsubscribe a socket from a generic room.

Overview

Parameters

Description Accepted Data Types Required ?
1 Socket object object Yes
2 Room Name string Yes

Example Usage

// Controller action

leaveFunRoom: function(req, res) {
    var roomName = req.param('roomName');
    sails.sockets.leave(req.socket, roomName);
    res.json({
      message: 'Left a fun room called '+roomName+'!'
    });
}

Note: req.socket is only valid if the action is triggered via a socket request, e.g. socket.get('/leaveFunRoom/someRoomName')

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