package async_extra

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

This module implements a RPC transport optimized for low-latency.

module Config : sig ... end

All the following create functions take a max_message_size argument in addition to a Config.t. The final max_message_size will be the min of both.

The rationale for this is that max_message_size is more a property of the protocol and should be specified by the programmer, while other configuration parameters are for tuning purposes.

module Reader : sig ... end
module Writer : sig ... end
include module type of struct include Async_rpc_kernel.Rpc.Transport end with module Reader := Reader with module Writer := Writer

Binary headers containing message lengths. All transports should use this to ensure binary compatibility.

type t = {
  1. reader : Reader.t;
  2. writer : Writer.t;
}
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val close : t -> unit Async_kernel.Deferred.t

Closes both parts of the transport.

val create : ?config:Config.t -> max_message_size:int -> Async_unix.Fd.t -> 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