Edit Page
io.socket.off()
Unbind the specified event handler (opposite of .on()).
io.socket.off(eventIdentity, handlerFn);
This method is here for completeness, but most apps should not need to use it. See below for more information.
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | eventIdentity |
The unique event identity associated with a server-sent message, e.g. "recipe" | |
| 2 | handlerFn |
The event handler function to unbind from the specified event. |
Notes
- If you decide to use this method, be careful!
io.socket.off()does not stop the this client-side socket from receiving any server-sent messages-- it just prevents the specified event handler from firing. Usually, the desired effect is to prevent messages from being sent altogether, which is critical if your server-sent messages contain private data. This happens automatically when a socket disconnects, but there are also rarer use cases where it is necessary to unsubscribe sockets from rooms while they are still connected. For example, consider a scenario where an admin user is banned from your system while viewing a realtime dashboard, and your app needs to prevent them from receiving all subsequent realtime updates. To force a client socket to stop receiving broadcasted messages, do not use this method. Instead, unsubscribe the socket in your server-side code:
- If the room was joined using
sails.sockets.join(), callsails.sockets.leave().- If the room was joined using resourceful pubsub methods, call
.unsubscribe()or.unwatch(), whichever is appropriate.- In order to use
.off(), you will need to store thehandlerFnargument you passed in to.on()in a variable.
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.