package rpclib

You can search for identifiers within the package.

in-package search v0.2.0

package rpclib

rpclib
- Rpclib
rpclib.cmdliner
- Cmdlinergen
  - Gen
rpclib.core
- Codegen
  - Gen
  - Interface
  - Interfaces
  - Method
- Idl
  - DefaultError
  - Error
    
    ERROR
    
    Make
    
    T
  - Exn
    
    GenClient
    
    R
    
    GenServer
  - ExnM
  - IdM
  - Interface
  - MONAD
  - Make
    
    ErrM
    
    GenClient
    
    GenServer
    
    M
    
    RPCTRANSFORMER
    
    T
  - Param
  - RPC
- Pythongen
- Rpc
- Rpc_genfake
- Rpcmarshal
rpclib.internals
- Internals
rpclib.json
- Jsonrpc
rpclib.markdown
- Markdowngen
rpclib.xml
- Xmlrpc

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

type 'a t = {

name : string option;
description : string list;
typedef : 'a Rpc.Types.def;
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

type boxed =

| Boxed : 'a t -> boxed

We box parameters to put them into lists

val 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