package dune-rpc

  1. Overview
  2. Docs
Communicate with dune using rpc

Install

Dune Dependency

Authors

Maintainers

Sources

dune-3.17.2.tbz
sha256=9deafeed0ecfe9e65e642cd8e6197f0864f73fcd7b94b5b199ae4d2e07a2ea64
sha512=1e85bb297a12c9571b8645541d85a719deffb619d5e4f48dbf4566ac14e9f385d8a05342698a6f9c81ba17325b1da4ad004a5772d66cd88ed135c43d43e88f9e

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.