Socket.io 0.7+ server implementation on top of Tornado framework
TornadIO2 is compatible with 0.7+ version of the Socket.IO and implements most of the features found in original Socket.IO server software.
- Supports Socket.IO 0.8 protocol and related features
- Full unicode support
- Support for generator-based asynchronous code (tornado.gen API)
- Statistics capture (packets per second, etc)
- Actively maintained
What is Socket.IO?
You can use it to build push service, games, etc. Socket.IO will adapt to the clients browser and will use most effective transport protocol available.
In order to start working with the TornadIO2 library, you have to have some basic Tornado knowledge. If you don’t know how to use it, please read Tornado tutorial, which can be found here.
If you’re familiar with Tornado, do following to add support for Socket.IO to your application:
Derive from tornadio2.SocketConnection class and override on_message method (on_open/on_close are optional):
class MyConnection(tornadio2.SocketConnection): def on_message(self, message): pass
Create TornadIO2 server for your connection:
MyRouter = tornadio2.TornadioRouter(MyConnection)
Add your handler routes to the Tornado application:
application = tornado.web.Application( MyRouter.urls, socket_io_port = 8000)
Start your application
You have your socket.io server running at port 8000. Simple, right?
We provide customized version (shamelessly borrowed from the SocketTornad.IO library) of the HttpServer, which simplifies start of your TornadIO server.
To start it, do following (assuming you created application object before):
if __name__ == "__main__": socketio_server = SocketServer(application)
SocketServer will automatically start Flash policy server, if required.
If you don’t want to start IOLoop immediately, pass auto_start = False as one of the constructor options and then manually start IOLoop.
For more information, check TornadIO2 documentation and sample applications.
Ping sample which shows how to use events to work in request-response mode. It is in the examples/ackping directory.
Chat sample which demonstrates how cross-site communication works (chat server is running on port 8002, while HTTP server runs on port 8001). It is in the examples/crosssite directory.
Events and generator-based async API
Example which shows how to use events and generator-based API to work with asynchronous code. It is in the examples/gen directory.
Ping and chat demo running through one connection. You can see it in examples/multiplexed directory.
TornadIO2 collects some counters that you can use to troubleshoot your application performance. Example in examples/stats directory gives an idea how you can use these stats to plot realtime graph.
Ping which works through socket.io events. It is in the examples/rpcping directory.
Simple ping/pong example with chat-like interface with selectable transports. It is in the examples/transports directory.