package dune-rpc

  1. Overview
  2. Docs
Communicate with dune using rpc

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (17)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Sources

dune-3.22.1.tbz
sha256=0c0b98396c32ec426886c2c2294024fd687ac5114d4dda0af9dc8a2e584d47fd
sha512=4dc4ed45fb52a3017bc73fdbcb7b88c1710cebfdbb87ecb6f933582f8f0a27ef740f8c4009439ff6a878e1115c3f29d199e63d0367a88a09d2ea19b61517a814

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 -> (Dune_rpc_private__.Types.Method.Name.t * int list) list
Sourceval declare_notification : 'state t -> 'payload Dune_rpc_private__.Types.Decl.Notification.t -> 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) Dune_rpc_private__.Types.Decl.Request.t -> unit
Sourceval implement_notification : 'state t -> 'payload Dune_rpc_private__.Types.Decl.Notification.t -> ('state -> 'payload -> unit Fiber.t) -> unit
Sourceval implement_request : 'state t -> ('req, 'resp) Dune_rpc_private__.Types.Decl.Request.t -> ('state -> 'req -> 'resp Fiber.t) -> unit