JsonRPC 2.0 server for the ngx_lua/openresty
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/resty
.gitignore
LICENSE
README.md
dist.ini

README.md

lua-resty-jsonrpc-server

lua-resty-jsonrpc-server -- JsonRPC 2.0 server for ngx_lua

Table of Contents

Description

This Lua library is a JsonRPC 2.0 server for the ngx_lua nginx module.

Synopsis

lua_package_path "/path/to/lua-resty-jsonrpc-server/lib/?.lua;;";

server {
	location /lua-jsonrpc-server {
		default_type "application/json";

		content_by_lua '
	        local jsonrpc_server = require "resty.jsonrpc_server"
	        local jsonrpc_demo = require "resty.jsonrpc_demo"

	        local server = jsonrpc_server:new()

	        local add1 = function(a, b)
	                return a + b
	        end

	        local register = server:register([[addition]], add1)

	        local binder = server:bind([[addition1]], jsonrpc_demo, [[add1]])

	        local result = server:execute()
	        
	        ngx.say(result);

		';
	}
}

Curl test

input

$ curl -d "{\"jsonrpc\":\"2.0\",\"method\":\"addition\", \"params\":[1,5]}" http://localhost/lua-jsonrpc-server

output

$ {"result":6,"jsonrpc":"2.0","id":"null"}

Methods

new

syntax: server, err = jsonrpc_server:new()

register

syntax: ok, err = jsonrpc_server:register(procedure, closure)

bind

syntax: ok, err = jsonrpc_server:bind(procedure, classname, method)

json_format

syntax: ok, err = jsonrpc_server:json_format()

rpc_format

syntax: ok, err = jsonrpc_server:rpc_format()

execute_procedure

syntax: ok, err = jsonrpc_server:execute_procedure(payload_method, payload_params)

execute_callback

syntax: ok, err = jsonrpc_server:execute_callback(method, params)

execute_method

syntax: ok, err = jsonrpc_server:execute_method(method, params)

get_response

syntax: ok, err = jsonrpc_server:get_response(data)

execute

syntax: ok, err = jsonrpc_server:execute()

rpc_error

syntax: ok, err = jsonrpc_server:rpc_error(code, message)

Jsonrpc 2.0 error

// Parse error
{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}

// Invalid Request
{"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"Invalid Request"}}

// Method not found
{"jsonrpc":"2.0","id":null,"error":{"code":-32601,"message":"Method not found"}}

// Invalid params
{"jsonrpc":"2.0","id":null,"error":{"code":-32602,"message":"Invalid params"}}

Author

rryqszq4 memwared@gmail.com.

Copyright and License

Copyright (c) 2015, rryqszq4 All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.