package json-rpc

  1. Overview
  2. Docs
JSON RPC

Install 

dune-project
 Dependency

github.com Edit opam file Versions (1)

Authors

  1. M
    Markus W. Weissmann <markus.weissmann@in.tum.de>

Maintainers

  1. M
    Markus W. Weissmann <markus.weissmann@in.tum.de>

Sources

0.5.0.tar.gz
sha256=f881e0d1cdf277ee6bde864c0a7939a4fcb880c0707540ad53c17f9b845baaa3
md5=f5f683fa4a5d025c530eee501347e7c7

doc/jsonrpc/Jsonrpc/Server/index.html

Module Jsonrpc.Server

type t

A JSON-RPC server

type reply = (json, int * string) Result.result

the return value of an JSON-RPC function

type callback = json option -> reply

a JSON-RPC function

module Error : sig ... end
val create : unit -> t

create a JSON-RPC server; the default function will be set to (fun _ -> Error.method_not_found), returning this error message as reply to all requests.

val add_cb : t -> name:string -> callback -> unit

add_cb srv ~name cb add the callback function cb to the server src. The function will be called in a JSON-RPC request matches the given function name name.

val set_default : t -> callback -> unit

set_default src cb sets the default callback function to cb in the server srv. This function is called if no callback function matches the function name in the RPC reuqest.

val remove_cb : name:string -> t -> unit

remove_cb ~name srv removes the callback function for name name from the server srv.

val evalj : t -> json -> json option

evalj srv json_in generates a return value for the given JSON-RPC request json_in for the server srv. If no answer is to be sent back to the caller, this function will return None.

val eval : t -> string -> string option

eval srv s works just like evalj srv json but will parse the value s to JSON; it also converts the reply to a string value to be sent back to the caller.