package dune-rpc
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=a10386f980cda9417d1465466bed50dd2aef9c93b9d06a0f7feeedb0a1541158
sha512=d1622939713133a1f28617229896298d6ef194c48a47d011e4b752490fc83893cc920a8395d7ac60bc384a6c9b233ebf0665f38f74f2774a983e9d3b241a7746
doc/dune-rpc/Dune_rpc/index.html
Module Dune_rpc
Source
Implementation of the protocol used by dune rpc. Independent of IO and any specific rpc requests. The protocol described here is stable and is relied on by 3rd party clients.
The implementation is loosely modelled on jsonrpc. It defines the following concepts:
Session - An active rpc session
Request - A unique id with a call sent by a client. A server must respond to every request
Notification - A call send by a client. A server must not respond to a notification
It contains hooks that make it possible to use with any custom scheduler that uses fibers
The API in this version is versioned. When using this library, we expect that the module corresponding to a particular version is used exclusively.
While we guarantee stability of the API, we reserve the right to:
- Add optional arguments to functions
- Add new fields to records
- New variant constructors that will not cause runtime errors in existing user programs.
This means that you must refrain from re-exporting any values, constructing any records, using any module types as functor arguments, or make non exhaustive matches an error to guarantee compatibility.