SailsSocket Methods
This section describes the methods available on each SailsSocket instance. Most of these methods can be called even before the socket connects to the server. In the case of request methods like .get() and .request(), calls will be queued up until the socket connects, at which time they will be replayed in order.
Basic methods
The most common methods you will use with a SailsSocket instance are documented in the main Socket Client reference section. These include .get(), .put(), .post(), .delete(), .request(), .on() and .off().
Advanced methods
In addition to the basic communication / event listening methods, each SailsSocket instance (including io.socket) exposes some additional methods for dealing with server connections.
.isConnected()
Determines whether the SailsSocket instance is currently connected to a server, returning true if a connection has been established.
io.socket.isConnected();
.disconnect()
Disconnect a SailsSocket instance from the server. Will throw an error if the socket is already disconnected.
io.socket.disconnect();
.reconnect()
Reconnect a SailsSocket instance to a server after being disconnected (either involuntarily or via a call to .disconnect()). The instance will connect using its currently configured properties. Throws an error if the socket is already connected to a server.
io.socket.reconnect();
While an instance is in a disconnected state, all of its properties may be changed. This allows you to disconnect an instance from one server and reconnect it to another without losing its event bindings or queued requests.
.removeAllListeners()
Stop listening for all server-related events on a SailsSocket instance. Note that this includes connect and disconnect events!
io.socket.removeAllListeners();
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.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- 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.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
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!
© 2012-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.