Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

WSRPC WebSocket RPC for tornado

Project description

Remote Procedure call through WebSocket between browser and tornado.

Installation

Install via pip:

pip install wsrpc-tornado

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
wsrpc-tornado-0.3.9.tar.gz (29.5 kB) Copy SHA256 hash SHA256 Source None Jul 14, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page