package async_rpc_kernel

  1. Overview
  2. Docs
package async_rpc_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

A state rpc is an easy way for two processes to synchronize a data structure by sending updates over the wire. It's basically a pipe rpc that sends/receives an initial state of the data structure, and then updates, and applies the updates under the covers.

type ('query, 'state, 'update, 'error) t
module Id : sig ... end
module Metadata : sig ... end
val create : ?client_pushes_back:unit -> name:string -> version:int -> bin_query:'query Core_kernel.Bin_prot.Type_class.t -> bin_state:'state Core_kernel.Bin_prot.Type_class.t -> bin_update:'update Core_kernel.Bin_prot.Type_class.t -> bin_error:'error Core_kernel.Bin_prot.Type_class.t -> unit -> ('query, 'state, 'update, 'error) t
val bin_query : ('query, _, _, _) t -> 'query Core_kernel.Bin_prot.Type_class.t
val bin_state : (_, 'state, _, _) t -> 'state Core_kernel.Bin_prot.Type_class.t
val bin_update : (_, _, 'update, _) t -> 'update Core_kernel.Bin_prot.Type_class.t
val bin_error : (_, _, _, 'error) t -> 'error Core_kernel.Bin_prot.Type_class.t
val implement : ('query, 'state, 'update, 'error) t -> ('connection_state -> 'query -> ('state * 'update Async_kernel.Pipe.Reader.t, 'error) Core_kernel.Result.t Async_kernel.Deferred.t) -> 'connection_state Implementation.t
val dispatch : ('query, 'state, 'update, 'error) t -> Connection.t -> 'query -> ('state * 'update Async_kernel.Pipe.Reader.t * Metadata.t, 'error) Core_kernel.Result.t Core_kernel.Or_error.t Async_kernel.Deferred.t
val abort : (_, _, _, _) t -> Connection.t -> Id.t -> unit
val client_pushes_back : (_, _, _, _) t -> bool
val name : (_, _, _, _) t -> string
val version : (_, _, _, _) t -> int
val description : (_, _, _, _) t -> Description.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct