Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

SockJS server implementation for aiohttp.

Project Description

aiosockjs is a SockJS server based on aiohttp PEP 3156 asyncio module.

aiosockjs is a SockJS integration for aiohttp. SockJS interface is implemented as a aiohttp route. Its possible to create any number of different sockjs routes, ie `/sockjs/* or /mycustom-sockjs/*. You can provide different session implementation and management for each sockjs route.

Simple aiohttp web server is required:

use = egg:gunicorn#main
host =
port = 8080
worker = aiohttp.worker.GunicornWebWorker

Example of sockjs route:

def main(global_settings, **settings):
    app = web.Application(loop=loop)
    app.router.add_route('GET', '/', index)
    sockjs.add_endpoint(app, prefix='/sockjs', handler=chatSession)

    handler = app.make_handler()
    srv = loop.run_until_complete(
        loop.create_server(handler, '', 8080))
    print("Server started at")
     except KeyboardInterrupt:

Client side code:

<script src="//"></script>
    var sock = new SockJS('http://localhost:8080/sockjs');

    sock.onopen = function() {

    sock.onmessage = function(obj) {

    sock.onclose = function() {


  1. Install virtualenv:

    $ wget
    $ python3.4 ./ --no-site-packages sockjs
  1. Clone aiosockjs from github and then install:

    $ git clone
    $ cd sockjs
    $ ../sockjs/bin/python develop

To run chat example use following command:

$ ./sockjs/bin/python ./aiosockjs/examples/

Supported transports

Not supported transports



You can find several examples in the aiosockjs repository at github.


aiosockjs is offered under the Apache 2 license.


0.6 (2017-04-13)

  • Fixed support for aiohttp 2.0+.

0.5 (2016-09-26)

  • Mark SockJSRoute.handler and SockJSRoute.websocket as coroutines. #25
  • Remove a check for “ORIGIN” header #12
  • Process FRAME_MESSAGE_BLOB message type #12

0.4 (2016-02-04)

  • Fixed lost event-loop argument in sockjs.transports.websocket.WebSocketTransport
  • Fixed lost event-loop argument in sockjs.transports.rawwebsocket.RawWebSocketTransport
  • Fixed RawRequestMessage. Add raw_header argument (aiohttp 0.21+)
  • Fixed many warnings
  • Fixed sockjs.route add_endpoint without name bug

0.3 (2015-08-07)

  • Fixed calls of SessionManager.aquire() - was removed the unnecessary second argument.
  • Fixed the incorrect argument in one call of cors_headers().
  • Fixed many errors. The code is not perfect, but at least it was working as it should.

0.2 (2015-07-07)

  • Fixed packaging

0.1.0 (2015-06-21)

  • Initial release

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(22.1 kB) Copy SHA256 Hash SHA256
Wheel py3 Apr 13, 2017
(32.9 kB) Copy SHA256 Hash SHA256
Source None Apr 13, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting