sanic-sockjs 0.1.0

SockJS server implementation for Sanic.

sanic_sockjs is a SockJS integration for Sanic. SockJS interface is implemented as a Sanic 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 Sanic web server is required:

[server:main]
use = egg:gunicorn#main
host = 0.0.0.0
port = 8080
worker = sanic.worker.GunicornWorker

Example of sockjs route:

def main(global_settings, **settings):
    app = Sanic(__main__)
    @app.get('/')
    def index(request):
        ...


    sanic_sockjs.add_endpoint(app, prefix='/sockjs', handler=chatSession)
    app.run("127.0.0.1", 8080)

Client side code:

<script src="//cdn.jsdelivr.net/npm/sockjs-client@1/dist/sockjs.js"></script>
<script>
    var sock = new SockJS('http://localhost:8080/sockjs');

    sock.onopen = function() {
      console.log('open');
    };

    sock.onmessage = function(obj) {
      console.log(obj);
    };

    sock.onclose = function() {
      console.log('close');
    };
</script>

Supported transports

• websocket hybi-10

• xhr-streaming

• xhr-polling

• iframe-xhr-polling

• iframe-eventsource (EventSource used from an iframe via postMessage)

• iframe-htmlfile (HtmlFile used from an iframe via postMessage.

• jsonp-polling

Requirements

• Python >= 3.6

• Sanic >= 19.3.1 https://github.com/huge-success/sanic

Examples

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

https://github.com/ashleysommer/sanic-sockjs/tree/master/examples

License

sockjs is offered under the Apache 2 license.

CHANGES

0.1.0 (2020-04-08)

• Initial release

• Ported from aiohttp/SockJS

• Works on all Sanic 19.3.1-to-19.12.2