package async_rpc_kernel

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

Module Connection.Heartbeat_configSource

Sourcetype t
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
Sourceval create : ?timeout:Core.Time_ns.Span.t -> ?send_every:Core.Time_ns.Span.t -> unit -> t

Each side of the connection has its own heartbeat config. It sends a heartbeat every send_every. If it doesn't receive any messages for timeout, whether it's a heartbeat or not, it drops the connection. It only checks whether timeout has elapsed when it sends heartbeats, so effectively timeout is rounded up to the nearest multiple of send_every.

Sourceval timeout : t -> Core.Time_ns.Span.t
Sourceval send_every : t -> Core.Time_ns.Span.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