Module rfc4627_jsonrpc_mochiweb

Description
Function Index
Function Details

Support for serving JSON-RPC via Mochiweb.

Introduced in: 1.2.0

Authors: Tony Garnock-Jones (tonygarnockjones@gmail.com), LShift Ltd. (query@lshift.net).

References

the Mochiweb home page

Description

Support for serving JSON-RPC via Mochiweb.

Familiarity with writing Mochiweb 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 Mochiweb 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, Response} is returned; otherwise, no_match is returned.

Function Details

handle/2

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

Response = {Code, ReplyHeaders, ReplyBody}
Code = integer()
ReplyHeaders = [{string(), string()}]
ReplyBody = string()

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

Call this function from your Mochiweb application's loop function, as follows:

  case rfc4627_jsonrpc_mochiweb:handle("/rpc", Req) of
       no_match ->
           handle_non_jsonrpc_request(Req);
       {ok, Response} ->
           Req:respond(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.