package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type message =
  1. | Ping
  2. | BigPing of Tezos_base.TzPervasives.Operation_hash.t list

Simple p2p message used by the nodes.

  • Ping is a none-message used by nodes in simple communication tests.
  • BigPing is used to add arbitrary long data (similar to mempools sent in the actual network) to test bandwidth and chunks splitting.
type metadata =
  1. | Metadata

t is a simple p2p nodes.

sync node join node to a synchronization barrier.

val default_ipv6_addr : Tezos_base.TzPervasives.P2p_addr.t

gen_points npoints addr generates npoints points using the given addr and an unused port given by the operating system by binding a fresh socket to the port 0.

These sockets are left open and returned by the function with the generated point, so that the operating system cannot reuse this port while the socket is opened.

The returned sockets are also configured with option SO_REUSEPORT so that user can bind its own socket using the generated point when desired. When a socket has finally been bounded to the given port, the user must close the socket to avoid file descriptor leaks.

val detach_nodes : ?timeout:float -> ?prefix:(int -> string) -> ?min_connections:(int -> int) -> ?max_connections:(int -> int) -> ?max_incoming_connections:(int -> int) -> ?p2p_versions:(int -> Tezos_base.TzPervasives.P2p_version.t list) -> ?msg_config: (int -> message Tezos_base.TzPervasives.P2p_params.message_config) -> ?trusted: (int -> Tezos_base.TzPervasives.P2p_point.Id.t list -> Tezos_base.TzPervasives.P2p_point.Id.t list) -> (int -> t -> unit Tezos_base.TzPervasives.tzresult Lwt.t) -> (Tezos_base.TzPervasives.P2p_point.Id.t * Unix.file_descr) list -> unit Tezos_base.TzPervasives.tzresult Lwt.t

detach_nodes f points creates a network with one node for each points. f is the behavior of each node. If the network is alive after ?timeout seconds, if any is provided, the Timeout error is returned. ?prefix associates a prefix used for logs to each nodes. ?min_connections, ?max_connections, ?max_incoming_connections, ?p2p_versions and ?msg_config are used to configure the connect handler of each nodes. ?trusted is used to configure the pool of each nodes.

With each point of points a file descriptor generated by the system that holds the point should be given. This file descriptor will be properly closed by this function. See gen_points for more details.

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