package async_extra

  1. Overview
  2. Docs
package async_extra
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Async_extra.Import.Rpc_kernel.Transport.Reader end
include S
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val close : t -> unit Async_kernel.Deferred.t
val is_closed : t -> bool
val read_forever : t -> on_message: (Core_kernel.Bigstring.t -> pos:int -> len:int -> 'a Async_rpc_kernel.Transport_intf.Handler_result.t) -> on_end_of_batch:(unit -> unit) -> ('a, [ `Eof | `Closed ]) Core_kernel.Result.t Async_kernel.Deferred.t

Start reading incoming messages and pass them to on_message, until it returns Stop _.

on_end_of_batch is called after processing a batch of messages, before waiting for the file descriptor to become readable again.

val pack : (module S with type t = 'a) -> 'a -> t
val read_one_message_bin_prot : t -> 'a Core_kernel.Bin_prot.Type_class.reader -> ('a, [ `Closed | `Eof ]) Core_kernel.Result.t Async_kernel.Deferred.t

Convenience function to wait for the first message and un-bin_prot it.

Async RPC uses this to handle the handshake at the beginning of the message stream.

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