Skip to main content

WSRPC WebSocket RPC for tornado

Project description

Remote Procedure call through WebSocket between browser and tornado.

Installation

Install via pip:

pip install wsrpc-tornado

Install ujson if you want:

pip install ujson

Simple usage

Add the backend side:

from time import time
from wsrpc import WebSocketRoute, WebSocketThreaded as WebSocket, wsrpc_static

tornado.web.Application((
    wsrpc_static(r'/js/(.*)'),
    (r"/ws/", WebSocket),
    (r'/(.*)', tornado.web.StaticFileHandler, {
         'path': os.path.join(project_root, 'static'),
         'default_filename': 'index.html'
    }),
))

class TestRoute(WebSocketRoute):
    def init(self, **kwargs):
        return kwargs

    def getEpoch(self):
        return time()

# stateful request
WebSocket.ROUTES['test1'] = TestRoute

# stateless request
WebSocket.ROUTES['test2'] = lambda *a, **kw: True

# initialize ThreadPool
WebSocket.init_pool()

Add the frontend side:

<script type="text/javascript" src="/js/q.min.js"></script>
<script type="text/javascript" src="/js/wsrpc.min.js"></script>
<script>
    var url = window.location.protocol==="https:"?"wss://":"ws://" + window.location.host + '/ws/';
    RPC = WSRPC(url, 5000);
    RPC.addRoute('test', function (data) { return "Test called"; });
    RPC.connect();

    RPC.call('test1.getEpoch').then(function (data) {
        console.log(data);
    }, function (error) {
        alert(error);
    }).done();

    RPC.call('test2').then(function (data) { console.log(data); }).done();
</script>

Example

Example running there demo.

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

wsrpc-tornado-0.5.0.tar.gz (29.6 kB view details)

Uploaded Source

File details

Details for the file wsrpc-tornado-0.5.0.tar.gz.

File metadata

File hashes

Hashes for wsrpc-tornado-0.5.0.tar.gz
Algorithm Hash digest
SHA256 783c590b13e25bc59d7b9b8970ecfcbf878779530360ee580e3c956902fbbad7
MD5 405f2f41349b1d7f47d3e2ef05852a04
BLAKE2b-256 a37d89c061ec9e3d1cf02b616c2ab408a5679ac8bd23be84235bd6e86a94360d

See more details on using hashes here.

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