The easiest way to send a realtime message from a client to a Sails app is by using the sails.io.js library. This library allows you to easily connect sockets to a running Sails app, and provides methods for making requests to Sails routes that are handled in the same manner as a "regular" HTTP request.
The sails.io.js library is automatically added to the default layout template of new Sails apps using a
<script> tag. When a web page loads the
sails.io.js script, it attempts to create a new client socket and connect it to the Sails app, exposing it as the global variable
sails.io.js library, and make a request to the
/hello route of a Sails app using the automatically-connected socket:
Now consider this more advanced (and much rarer) use case: Let's disable the eager (auto-connecting) socket, and instead create a new client socket manually. When it successfully connects to the server, we'll make it log a message:
You may have noticed that a client socket
.get() is very similar to making an AJAX request, for example by using jQuery's
$.get() method. This is intentional—the goal is for you to be able to get the same response from Sails no matter where the request originated from. The benefit to making the request using a client socket is that the controller action in your Sails app will have access to the socket which made the request, allowing it to subscribe that socket to realtime notifications (see sending realtime messages from the server).