package rpclib

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

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (2)

Authors

  1. T
    Thomas Gazagnaire
  2. J
    Jon Ludlam

Maintainers

  1. M
    Marcello Seri

Sources

rpclib-10.0.0.tbz
sha256=1d62cf36ff3f599286ff6c77a3266b04d9e14df73d3fce078d51ab9c4c7bad3a
sha512=9fe0bc38363c35e5ec185eadc096565f7f76e219bfde62756dee2cbc818e7663e1ce2e730a235f2bf2230a24ff52b29bcc8e1082e0a43d7e6c23f56ad74add43

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