SailsSocket methods
This section describes the methods available on each SailsSocket instance. Most of these methods can be called before the socket even 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 executed 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 and event-listening methods, each SailsSocket instance (including io.socket) exposes several methods for dealing with server connections.
.isConnected()
Determines whether the SailsSocket instance is currently connected to a server; returns true if a connection has been established.
io.socket.isConnected();
.isConnecting()
Determines whether the SailsSocket instance is currently in the process of connecting to a server; returns true if a connection is being attempted.
io.socket.isConnecting();
.mightBeAboutToAutoConnect()
Detects when the SailsSocket instance has already loaded but is not yet fully configured or has not attempted to autoconnect.
The sails.io.js library waits one tick of the event loop before checking whether autoConnect is enabled and, if so, trying to connect. This allows you to configure the SailsSocket instance (for example, by setting io.sails.url) before an attempt is made to estabilish a connection. The mightBeAboutToAutoConnect() method returns true in the situation where sails.io.js has loaded, but the requisite tick of the event loop has not yet elapsed.
io.socket.mightBeAboutToAutoConnect();
.disconnect()
Disconnects a SailsSocket instance from the server; throws an error if the socket is already disconnected.
io.socket.disconnect();
.reconnect()
Reconnects a SailsSocket instance to a server after it's been disconnected (either involuntarily or via a call to .disconnect()). The instance connects using its currently configured properties. .reconnect() throws an error if the socket is already connected to a server.
io.socket.reconnect();
When an instance is in a disconnected state, its properties may be changed. This means that an instance that has been disconnected from one server can be reconnected to another without losing its event bindings or queued requests.
.removeAllListeners()
Stops listening for any server-related events on a SailsSocket instance, including connect and disconnect.
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.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
Reference
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-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.