Sockets (sails.sockets)
Overview
Sails exposes several methods (sails.sockets.*) that provide a simple interface for realtime communication with connected socket clients. These are useful for pushing events and data to connected clients in realtime, rather than waiting for their HTTP requests. These methods are available regardless of whether a client socket was connected from a browser tab, an iOS app, or your favorite household IoT appliance.
These methods are implemented using a built-in instance of Socket.IO, which is available directly as sails.io. However, you should almost never use sails.io directly. Instead, you should call the methods available on sails.sockets.*. In addition, for certain use cases, you might also want to take advantage of resourceful PubSub methods, which access a higher level of abstraction and are used by Sails' built-in blueprint API.
Methods
| Method | Description |
|---|---|
.addRoomMembersToRooms() |
Subscribe all members of a room to one or more additional rooms. |
.blast() |
Broadcast a message to all sockets connected to the server. |
.broadcast() |
Broadcast a message to all sockets in a room. |
.getId() |
Parse the socket ID from an incoming socket request (req). |
.join() |
Subscribe a socket to a room. |
.leave() |
Unsubscribe a socket from a room. |
.leaveAll() |
Unsubscribe all members of one room from that room and from every other room they are currently subscribed to, except the automatic room with the same name as each socket ID. |
.removeRoomMembersFromRooms() |
Unsubscribe all members of a room from one or more other rooms. |
Don't see a method you're looking for above? A number of
sails.socketsmethods were deprecated in Sails v0.12, either because a more performant alias was already available, or for performance and scalability reasons. Please see the v0.12 migration guide for more information.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is built by a web & mobile shop 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!
© 2012-2021 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.