Module rfc4627_jsonrpc_cowboy

Description
Function Index
Function Details

Support for serving JSON-RPC via Cowboy.

Authors: Erik Timan (dev@timan.info), Tony Garnock-Jones (tonygarnockjones@gmail.com), LShift Ltd. (query@lshift.net).

References

the Cowboy github page

Description

Support for serving JSON-RPC via Cowboy.

Familiarity with writing Cowboy applications is assumed.

Basic Usage

Register your JSON-RPC services as usual.
Decide on your AliasPrefix (see rfc4627_jsonrpc_http:invoke_service_method/4).
When a Cowboy request arrives at your application, call handle/2 with your AliasPrefix and the request.

It's as simple as that - if the request's URI path matches the AliasPrefix, it will be decoded and the JSON-RPC service it names will be invoked.

Function Index

handle/2 If the request matches AliasPrefix, the corresponding JSON-RPC service is invoked, and an {ok, #http_req{}} is returned; otherwise, no_match is returned.

Function Details

handle/2

handle(AliasPrefix::string(), Req::#http_req{}) -> no_match | {ok, #http_req{}}

If the request matches AliasPrefix, the corresponding JSON-RPC service is invoked, and an {ok, #http_req{}} is returned; otherwise, no_match is returned.

Call this function from your Cowboy HTTP handler's handle function, as follows:

  Req2 = case rfc4627_jsonrpc_cowboy:handle("/rpc", Req) of
            no_match ->
                handle_non_jsonrpc_request(Req);
            {ok, Reponse} ->
                Response
        end

where handle_non_jsonrpc_request does the obvious thing for non-JSON-RPC requests.

Generated by EDoc, Nov 21 2012, 14:49:54.