Realtime communication in a multi-server (aka "clustered") environment
With the default configuration, Sails allows realtime communication between a single server and all of its connected clients. When scaling your Sails app to multiple servers, some extra setup is necessary in order for realtime messages to be reliably delivered to clients regardless of which server they’re connected to. This setup typically involves:
- Setting up a hosted instance of Redis.
- Installing @sailshq/socket.io-redis as a dependency of your Sails app.
- Updating your sails.config.sockets.adapter setting to
@sailshq/socket.io-redisand setting the appropriatehost,password, etc. fields to point to your hosted Redis instance.
No special setup is necessary in your hosted Redis install; just plug the appropriate host address and credentials into your /config/sockets.js file and the @sailshq/socket.io-redis adapter will take care of everything for you.
Note: When operating in a multi-server environment, some socket methods without callbacks are volatile, meaning that they take an indeterminate amount of time to complete, even if the code appears to execute immediately. It's good to keep this in mind when considering code that would, for example, follow a call to
.addRoomMembersToRoom()immediately with a call to.broadcast(). In such cases, the new room member probably won't receive the newly broadcasted message, since it is unlikely that the updated room membership had already been propagated to the other servers in the cluster when.broadcast()was called.
Reference
- See the full reference for the sails.io.js library to learn how to use sockets on the client side to communicate with your Sails app.
- See the sails.sockets reference to learn how to send messages from the server to connected sockets
- See the resourceful pub-sub reference to learn how to use Sails blueprints to automatically send realtime messages about changes to your models.
- Visit the Socket.io website to learn more about the underlying library Sails uses for realtime communication
For a better experience on sailsjs.com, update your browser.
Concepts
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.