SockJS family:

• SockJS-client JavaScript client library
• SockJS-node Node.js server
• SockJS-erlang Erlang server
• SockJS-cyclone Python/Cyclone/Twisted server
• SockJS-tornado Python/Tornado server
• SockJS-twisted Python/Twisted server
• Spring Framework Java client & server
• vert.x Java/vert.x server
• Xitrum Scala server
• Atmosphere Framework JavaEE Server, Play Framework, Netty, Vert.x

Work in progress:

• SockJS-ruby
• SockJS-netty
• SockJS-gevent (SockJS-gevent fork)
• pyramid-SockJS
• wildcloud-websockets
• wai-SockJS
• SockJS-perl
• SockJS-go

SockJS-protocol

This project attempts to provide a definition of SockJS protocol. The documentation is in a form of a Python test suite decorated with some prose in literate-programming style. You can see current documentation here:

• Current stable: sockjs-protocol-0.3.3.html

Running tests

You must have Python 2.X and virtualenv installed. You can install it via pip install virtualenv or sudo apt-get install python-virtualenv.

To run the test suite against your server, first checkout dependencies:

make test_deps

And you're ready to run the tests against your server. By default we assume that your test server is at http://localhost:8081:

./venv/bin/python sockjs-protocol-0.3.3.py

You can specify the test server URL manually:

SOCKJS_URL=http://localhost:1234 ./venv/bin/python sockjs-protocol-0.3.3.py -v

You can run specific tests providing test class as an optional argument:

./venv/bin/python sockjs-protocol-0.3.3.py Protocol.test_simpleSession

There is also another test, intended to look for some http quirks:

./venv/bin/python http-quirks.py -v

Generating literate html

If you edited sockjs-protocol*.py files, you may want to see how it looks rendered to html. To generate the html type:

make build

You should see generated html files in docs subdirectory.

If you see pygments.util.ClassNotFound, take a look here.