UNPKG

sails

Version:

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

sailsjs.com

balderdashy/sails

21 lines (13 loc) • 2.97 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 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](https://sailsjs.com/documentation/concepts/deployment/scaling), some extra setup is necessary in order for realtime messages to be reliably delivered to clients regardless of which server they&rsquo;re connected to. This setup typically involves: 1. Setting up a [hosted](https://www.google.com/search?q=hosted+redis) instance of [Redis](http://redis.io/). 2. Installing [@sailshq/socket.io-redis](https://npmjs.com/package/@sailshq/socket.io-redis) as a dependency of your Sails app. 1. Updating your [sails.config.sockets.adapter](https://sailsjs.com/documentation/reference/configuration/sails-config-sockets#?commonlyused-options) setting to `@sailshq/socket.io-redis` and setting the appropriate `host`, `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()`](https://sailsjs.com/documentation/reference/web-sockets/sails-sockets/add-room-members-to-room) immediately with a call to [`.broadcast()`](https://sailsjs.com/documentation/reference/web-sockets/sails-sockets/sails-sockets-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](https://sailsjs.com/documentation/reference/web-sockets/socket-client) to learn how to use sockets on the client side to communicate with your Sails app. * See the [sails.sockets](https://sailsjs.com/documentation/reference/web-sockets/sails-sockets) reference to learn how to send messages from the server to connected sockets * See the [resourceful pub-sub](https://sailsjs.com/documentation/reference/web-sockets/resourceful-pub-sub) reference to learn how to use Sails blueprints to automatically send realtime messages about changes to your [models](https://sailsjs.com/documentation/concepts/models-and-orm/models). * Visit the [Socket.io](http://socket.io) website to learn more about the underlying library Sails uses for realtime communication <docmeta name="displayName" value="Multi-server environments">