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.4.0.tar.gz (29.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for wsrpc-tornado-0.4.0.tar.gz
Algorithm Hash digest
SHA256 05018072317cc69a2c7f7f2fccd2ac883c7c373f033619f37ce2f05be03d066c
MD5 aa637a98627128647567e3e648558db1
BLAKE2b-256 da1e6c6afc772cdad0ec13a0f2ec5b15049a06cd88810fbee1ebfecd786ec124

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