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 (13)

Authors

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

Maintainers

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

Sources

dune-3.21.1.tbz
sha256=84f7a82c6d80a7124f3847e9a489e80cfbeafb7bed3573ac01286ef56fd08d94
sha512=d9fa44e24036d2593adfe59e52e0ad64f3e7e973d23f84af57fc79e38fa210630b0cb55590f314d6ef455333b96a8e0ce188c2720eaae44576222541ba78efb3

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