package rpclib

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

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

doc/rpclib.core/Idl/index.html

Module IdlSource

The Idl module is for declaring the types and documentation for RPC calls

Sourcemodule Param : sig ... end

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

Sourcemodule Error : sig ... end
Sourcemodule Interface : sig ... end

An interface is a collection of RPC declarations.

Sourceexception MarshalError of string

Raised when the client/server failed to unmarshal the RPC response/request.

Sourceval get_wire_name : Interface.description option -> string -> string
Sourceval get_arg : Rpc.call -> bool -> string option -> bool -> (Rpc.t * Rpc.call, [> `Msg of string ]) result
Sourcemodule type RPC = sig ... end

The RPC module type is the standard module signature that the various specialization modules must conform to.

Sourcemodule type MONAD = sig ... end
Sourceexception NoDescription

For the Server generation, the 'implement' function call _must_ be called before any RPCs are described. This exception will be raised if the user tries to do this.

Sourcemodule Make (M : MONAD) : sig ... end
Sourcemodule ExnM : sig ... end
Sourcemodule IdM : sig ... end
Sourcemodule DefaultError : sig ... end
Sourcemodule Exn : sig ... end