package dune-rpc

  1. Overview
  2. Docs
Communicate with dune using rpc

Install

Dune Dependency

Authors

Maintainers

Sources

dune-3.18.2.tbz
sha256=56be509ffc3c5ba652113d9e6b43edb04a691f1e1f6cbba17b9d243b1239a7af
sha512=ee04a0c4ab946817018c78cd9b19c8d3082ee3b1cef78c699fff4ea37fd79543823a9751d0b945d2fd1783396ceded045cbec986a85f7a8f7bac93e04650fff3

doc/dune-rpc.private/Dune_rpc_private/Versioned/Make/Builder/index.html

Module Make.BuilderSource

Sourcetype 'state t
Sourceval to_handler : 'state t -> session_version:('state -> int * int) -> menu:Menu.t -> 'state Handler.t
Sourceval create : unit -> 'state t
Sourceval registered_procedures : 'a t -> (Method.Name.t * Method.Version.t list) list
Sourceval declare_notification : 'state t -> 'payload Decl.notification -> unit

A *declaration* of a procedure is a claim that this side of the session is able to *initiate* that procedure. Correspondingly, *implementing* a procedure enables you to *receive* that procedure (and probably do something in response).

Currently, attempting to both implement and declare the same procedure in the same builder will raise. While there is nothing fundamentally wrong with allowing this, it is simpler for the initial version negotiation to treat all method names uniformly, rather than specifying whether a given (set of) generation(s) is implemented or declared.

Finally, attempting to declare or implement the same generation twice will also raise.

Sourceval declare_request : 'state t -> ('req, 'resp) Decl.request -> unit
Sourceval implement_notification : 'state t -> 'payload Decl.notification -> ('state -> 'payload -> unit Fiber.t) -> unit
Sourceval implement_request : 'state t -> ('req, 'resp) Decl.request -> ('state -> 'req -> 'resp Fiber.t) -> unit
OCaml

Innovation. Community. Security.