Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 1.78 KB

README.md

File metadata and controls

63 lines (49 loc) · 1.78 KB
Raw

TornRPC

A tornado RPC library.

This RPC framework uses tornado so its very quick and asynchronous.

This framework supports regular and asynchronous methods to be registered with the TornRPCServer. The below example shows both. The only difference in the framework is how you register it. Normal functions are registered using server.register(). Async functions are registered using server.register_async().

Each registered function will be turned into an HTTP endpoint on the server that you can manually curl yourself. See example server code below for info.

For more detailed info see the docstring for TornRPCClient and TornRPCServer.

For a real example of a server using this see https://github.com/sk8erwitskil/KVServer/blob/master/server.py

install

pip install TornRPC

See https://pypi.python.org/pypi/TornRPC

example server code

from tornado import gen
from tornrpc.server import TornRPCServer

def test(arg):
  return "You said %s" % arg

@gen.coroutine
def testasync(arg):
  raise gen.Return("You said async %s" % arg)

server = TornRPCServer()
server.register(test)
server.register_async(testasync)
server.start(8080)

These registered functions will turn into HTTP endpoints. You can manually curl them like this:

curl -H "User-Agent: TornRPC" -X GET -d "arg=hi%20there" http://localhost:8080/testasync

example client code

from tornrpc.client import TornRPCClient

client = TornRPCClient('localhost:8080')
print client.test('hi')
print client.testasync('hi')

features

  • auto-complete/tab-completion of remote methods in the client. Useful in iPython.
  • backed by tornado. very quick, asynchronous framework able to handle thousands of concurent connections
  • ability to register async and non-async functions