package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13
doc/octez-shell-libs.p2p_test_common/Tezos_p2p_test_common/Node/index.html
Module Tezos_p2p_test_common.NodeSource
Simple p2p message used by the nodes.
Pingis a none-message used by nodes in simple communication tests.BigPingis used to add arbitrary long data (similar to mempools sent in the actual network) to test bandwidth and chunks splitting.
type t = {iteration : int ref;channel : (unit, unit) Process.Channel.t;connect_handler : (message, metadata, metadata) Tezos_p2p.P2p_connect_handler.t;pool : (message, metadata, metadata) Tezos_p2p.P2p_pool.t;watcher : Tezos_base.TzPervasives.P2p_connection.P2p_event.t Lwt_watcher.input;trigger : Tezos_p2p.P2p_trigger.t;points : Tezos_base.TzPervasives.P2p_point.Id.t list;trusted_points : Tezos_base.TzPervasives.P2p_point.Id.t list;
}t is a simple p2p nodes.
sync node join node to a synchronization barrier.
val gen_points :
int ->
Tezos_base.TzPervasives.P2p_addr.t ->
(Tezos_base.TzPervasives.P2p_point.Id.t * Unix.file_descr) listgen_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.tdetach_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.