Skip to content

Commit 2a8befd

Browse files
Tornado examples readme
1 parent 415af12 commit 2a8befd

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

examples/tornado/README.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Socket.IO Tornado Examples
2+
==========================
3+
4+
This directory contains example Socket.IO applications that are compatible
5+
with the Tornado framework. These applications require Tornado 5 and Python
6+
3.5 or later.
7+
8+
app.py
9+
------
10+
11+
A basic "kitchen sink" type application that allows the user to experiment
12+
with most of the available features of the Socket.IO server.
13+
14+
latency.py
15+
----------
16+
17+
A port of the latency application included in the official Engine.IO
18+
Javascript server. In this application the client sends *ping* messages to
19+
the server, which are responded by the server with a *pong*. The client
20+
measures the time it takes for each of these exchanges and plots these in real
21+
time to the page.
22+
23+
This is an ideal application to measure the performance of the different
24+
asynchronous modes supported by the Socket.IO server.
25+
26+
Running the Examples
27+
--------------------
28+
29+
To run these examples, create a virtual environment, install the requirements
30+
and then run::
31+
32+
$ python app.py
33+
34+
or::
35+
36+
$ python latency.py
37+
38+
You can then access the application from your web browser at
39+
``http://localhost:8888``.

0 commit comments

Comments
 (0)