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 (1)

Authors

  1. T
    Thomas Gazagnaire
  2. J
    Jon Ludlam

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

rpclib-9.0.0.tbz
sha256=ce23eb756c028d9374bd19823296bddb7c237d3f055452d30d1cf7d15216e963
sha512=d4dfd7a9ee1b7996c24819ac1895925af0ad732f117c6e06cd28c215b14aa094dbd045e44d7f84c0eeb7ab807ed970d6879c29d07b02377fcb928325124ba7f6

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