package rpc_parallel

  1. Overview
  2. Docs
package rpc_parallel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. max_message_size : int option;
  2. handshake_timeout : Core.Time_float.Span.t option;
  3. heartbeat_config : Async.Rpc.Connection.Heartbeat_config.t option;
}
include Core.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __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.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val env_var : string

env_var is the name of the environment variable read by rpc-parallel on start-up to inject additional rpc-settings for the application.

val default : t

Use all the default rpc settings. This is the record with None in every field.

val to_string_for_env_var : ?max_message_size:int -> ?handshake_timeout:Core.Time_float.Span.t -> ?heartbeat_config:Async.Rpc.Connection.Heartbeat_config.t -> unit -> string

to_string_for_env_var generates the expected string format from the arguments matching the start_app function to be used with the env_var above.

val create_with_env_override : max_message_size:int option -> handshake_timeout:Core.Time_float.Span.t option -> heartbeat_config:Async.Rpc.Connection.Heartbeat_config.t option -> t
module For_internal_testing : sig ... end
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