Skip to main content

SockJS server implementation for aiohttp.

Project description

https://secure.travis-ci.org/aio-libs/sockjs.svg

sockjs 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:

[server:main]
use = egg:gunicorn#main
host = 0.0.0.0
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, '127.0.0.1', 8080))
    print("Server started at http://127.0.0.1:8080")
    try:
        loop.run_forever()
     except KeyboardInterrupt:
        srv.close()
        loop.run_until_complete(handler.finish_connections())

Client side code:

<script src="//cdn.jsdelivr.net/sockjs/0.3.4/sockjs.min.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

Requirements

Examples

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

https://github.com/aio-libs/sockjs/tree/master/examples

License

sockjs is offered under the Apache 2 license.

CHANGES

0.9.0 (2018-10-11)

  • Support Python 3.7. The minimal available Python version is 3.5.3 (#240)

0.8.0 (2018-06-15)

  • Fix heartbeat (#214)

0.7.1 (2018-03-05)

  • Fix compatibility with aiohttp 3.0+ again.

0.7.0 (2018-02-25)

  • Fixed compatibility with aiohttp 3.0+ (#169)

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

Project details


Download files

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

Source Distribution

sockjs-0.9.0.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

sockjs-0.9.0-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file sockjs-0.9.0.tar.gz.

File metadata

  • Download URL: sockjs-0.9.0.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for sockjs-0.9.0.tar.gz
Algorithm Hash digest
SHA256 c3ea4f1cc9bbd5bf7192b1520f51764cfc3b6b54ed3e0c9d76bfb34ee539f21e
MD5 1f3e79adb58c42fdcd7837833ec356fb
BLAKE2b-256 82e1fc89ef4f85eb7a8c2651cd2959f851afb7f6666fd3bd7bd4e38aa41bcbfd

See more details on using hashes here.

Provenance

File details

Details for the file sockjs-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: sockjs-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for sockjs-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5112f9cb28fcc00c67a70f6d2be3841bc1794846d1804cc75f067c69191bba8
MD5 dd023d9135f4ec68bcd48dbb7914fec6
BLAKE2b-256 3c8c0579104ae7b5b1935fc9c8dfc9cb90cd721a027069156205e3201cea24cb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page