package rpclib

  1. Overview
  2. Docs
A library to deal with RPCs in OCaml

Install 

dune-project
 Dependency

github.com Edit opam file Versions (3)

Authors

  1. T
    Thomas Gazagnaire
  2. J
    Jon Ludlam

Maintainers

  1. M
    Marcello Seri

Sources

rpclib-10.2.0.tbz
sha256=37ec4a4dd53fcb2d38d846415d3a45976d5a78c1531e6d876db2436e947172f3
sha512=4757df16d7cf2220787e2a6532e47130049894741ae1635e017cd583f28c5e55c016768d992c6739da70b29283141070f974f246b1ef467e64b034c5c231b00a

doc/rpclib.core/Idl/Param/index.html

Module Idl.ParamSource

The Param module is associated with parameters to RPCs. RPCs are defined in terms of 'a Param.t values.

Sourcetype 'a t = {
  1. name : string option;
  2. description : string list;
  3. typedef : 'a Rpc.Types.def;
  4. version : Rpc.Version.t option;
}

A Param.t has a name, description and a typedef. We may also want to add in here default values, example values and so on

Sourcetype boxed =
  1. | Boxed : 'a t -> boxed

We box parameters to put them into lists

Sourceval mk : ?name:string -> ?description:string list -> ?version:Rpc.Version.t -> 'a Rpc.Types.def -> 'a t

mk ~name ~description typ creates a Param.t out of a type definition from the Types module. If the name or description are omitted, the name or description from the type definition will be inherited