package dune-rpc

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package dune-rpc

dune-rpc
- Dune_rpc
  - V1
    
    Ansi_color
    
    RGB24
    
    RGB8
    
    Style
    
    Client
    
    Make
    
    Batch
    
    Chan
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    Stream
    
    Versioned
    
    S
    
    Batch
    
    Handler
    
    Stream
    
    Versioned
    
    Diagnostic
    
    Event
    
    Id
    
    Promotion
    
    Related
    
    Id
    
    Initialize
    
    Job
    
    Event
    
    Id
    
    Loc
    
    Message
    
    Notification
    
    Path
    
    Progress
    
    Registry
    
    Config
    
    Dune
    
    Poll
    
    Fiber
    
    O
    
    _
    
    Refresh
    
    Request
    
    Response
    
    Error
    
    Sub
    
    Target
    
    User_message
    
    Style
    
    Version_error
    
    Where
    
    Make
    
    Fiber
    
    O
    
    _
    
    S
dune-rpc.private
- Dune_rpc_private
  - Ansi_color
    
    RGB24
    
    RGB8
    
    Style
  - Call
  - Client
    
    Make
    
    Batch
    
    Chan
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    Stream
    
    Versioned
    
    S
    
    Batch
    
    Handler
    
    Stream
    
    Versioned
  - Conv
  - Decl
    
    Notification
    
    Request
  - Diagnostic
    
    Event
    
    Id
    
    Promotion
    
    Related
  - Fiber
    
    Ivar
    
    O
  - Id
    
    Map
    
    Multi
    
    Set
  - Initialize
    
    Request
    
    Response
  - Job
    
    Event
    
    Id
  - Loc
  - Menu
  - Message
  - Method
    
    Name
    
    Version
  - Packet
  - Path
  - Procedures
    
    Poll
    
    Name
    
    Public
    
    Server_side
  - Progress
  - Protocol
  - Public
    
    Notification
    
    Request
    
    Sub
  - Registry
    
    Config
    
    Dune
    
    File
    
    Poll
    
    Fiber
    
    O
    
    _
    
    Refresh
  - Request
  - Response
    
    Error
  - Server_notifications
  - Sub
  - Target
  - User_message
    
    Style
  - Version
  - Version_error
  - Version_negotiation
    
    Request
    
    Response
  - Versioned
    
    Make
    
    Builder
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    S
    
    Builder
    
    Handler
    
    Staged
  - Where
    
    Make
    
    Fiber
    
    O
    
    _
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functor to create a client implementation

Rpc client

Parameters

module Fiber : sig ... end

module Chan : sig ... end

Signature

type t

module Handler : sig ... end

module Versioned : sig ... end

Individual RPC procedures are versioned beyond the larger API version. At session startup, the server and client exchange version information for each method ("negotiation"), setting on a common version for each (if possible) to produce a "version menu".

val request : 
  ?id:Id.t ->
  t ->
  ('a, 'b) Versioned.request ->
  'a ->
  ('b, Response.Error.t) Stdlib.result Fiber.t

request ?id client decl req send a request req specified by decl to client. If id is None, it will be automatically generated.

val notification : t -> 'a Versioned.notification -> 'a -> unit Fiber.t

val disconnected : t -> unit Fiber.t

disconnected client produces a fiber that only becomes determined when the session is ended from the server side (such as if the build server is killed entirely).

module Stream : sig ... end

Control for a polling loop

val poll : 
  ?id:Id.t ->
  t ->
  'a Sub.t ->
  ('a Stream.t, Version_error.t) Stdlib.result Fiber.t

poll client sub Initialize a polling loop for sub

module Batch : sig ... end

val connect : 
  ?handler:Handler.t ->
  Chan.t ->
  Initialize.t ->
  f:(t -> 'a Fiber.t) ->
  'a Fiber.t

connect ?on_handler session init ~f connect to session, initialize with init and call f once the client is initialized. handler is called for some notifications sent to session