@@ -15,6 +15,32 @@ web browsers) and a server. The official implementations of the client
1515and server components are written in JavaScript. This package provides
1616Python implementations of both, each with standard and asyncio variants.
1717
18+ Version compatibility
19+ ---------------------
20+
21+ The Socket.IO protocol has been through a number of revisions, and some of these
22+ introduced backward incompatible changes, which means that the client and the
23+ server must use compatible versions for everything to work.
24+
25+ If you are using the Python client and server, the easiest way to ensure compatibility
26+ is to use the same version of this package for the client and the server. If you are
27+ using this package with a different client or server, then you must ensure the
28+ versions are compatible.
29+
30+ The version compatibility chart below maps versions of this package to versions
31+ of the JavaScript reference implementation and the versions of the Socket.IO and
32+ Engine.IO protocols.
33+
34+ +------------------------------+-----------------------------+-----------------------------+-------------------------+
35+ | JavaScript Socket.IO version | Socket.IO protocol revision | Engine.IO protocol revision | python-socketio version |
36+ +==============================+=============================+=============================+=========================+
37+ | 0.9.x | 1, 2 | 1, 2 | Not supported |
38+ +------------------------------+-----------------------------+-----------------------------+-------------------------+
39+ | 1.x and 2.x | 3, 4 | 3 | 4.x |
40+ +------------------------------+-----------------------------+-----------------------------+-------------------------+
41+ | 3.x | 5 | 4 | 5.x |
42+ +------------------------------+-----------------------------+-----------------------------+-------------------------+
43+
1844Client Examples
1945---------------
2046
0 commit comments