GenServer (reference.rpclib.rpclib.core.Idl.Exn.GenServer)

Parameters

Signature

include RPC
  with type implementation = server_implementation
   and type 'a res = 'a -> unit
   and type ('a, 'b) comp = 'a

Sourcetype implementation = server_implementation

The implementation is dependent on the module, and represents the 'result' of the entire module. For example, in the Server module, the `implementation` is the server function, with type

Rpc.call -> Rpc.response.

For the Client module, the individual declarations are used to perform the RPCs, and the 'implementation' type is simply unit.

Sourceval implement : Interface.description -> implementation

To actually construct the implementation, an interface description must be provided

Sourcetype 'a res = 'a -> unit

'a res is the result type of declaring a function. For example, the Client module, given an (int -> int -> int) fn, will return a function of type 'a - in this case, (int -> int -> int)

Sourcetype ('a, 'b) comp = 'a

This is for inserting a type in between the function application and its result. For example, this could be an Lwt.t, meaning that the result of a function application is a thread

Sourcetype _ fn

The GADT specifying the type of the RPC

Sourceval (@->) : 'a Param.t -> 'b fn -> ('a -> 'b) fn

This infix operator is for constructing function types

Sourceval noargs : 'b fn -> (unit -> 'b) fn

Require a unit argument in OCaml without sending a parameter. Useful for methods that take no arguments.

Sourceval returning : 'a Param.t -> 'b Error.t -> ('a, 'b) comp fn

This defines the return type of an RPC

Sourceval declare : string -> string list -> 'a fn -> 'a res

declare name description typ is how an RPC is declared to the module implementing the functionality. The return type is dependent upon the module being used

Sourceval declare_notification : string -> string list -> 'a fn -> 'a res

declare_notification name description typ is mostly the same as declare, only that it allows support from JSON-RPC notifications.