package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides functions used for tests.

type 'a timeout_t = {
  1. time : float;
    (*

    Duration of the timeout.

    *)
  2. msg : 'a -> string;
    (*

    Create the error message.

    *)
}

Is a timeout used with wait_pred function.

val wait_pred : ?timeout:'a timeout_t -> pred:('a -> bool) -> arg:'a -> unit -> unit Tezos_base.TzPervasives.tzresult Lwt.t

wait_pred wait until pred arg is true. If pred is not satisfy after timeout.time seconds a Timeout (timeout.msg arg) error is raised.

val wait_pred_s : ?timeout:'a timeout_t -> pred:('a -> bool Lwt.t) -> arg:'a -> unit -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Same as wait_pred.

val wait_conns : ?timeout:float -> pool:('a, 'b, 'c) Tezos_p2p.P2p_pool.t -> int -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Based on wait_pred. wait_conns ~pool n waits until at least n connections are actives in ~pool.

val connect_all : ?timeout:Tezos_base.TzPervasives.Time.System.Span.t -> ('a, 'b, 'c) Tezos_p2p.P2p_connect_handler.t -> Tezos_base.TzPervasives.P2p_point.Id.t list -> ('a, 'b, 'c) Tezos_p2p.P2p_conn.t list Tezos_base.TzPervasives.tzresult Lwt.t

connect_all connect_handler points establishes the connections to points using connect_handler and returns them. If one connection need more than ?timeout seconds to be established, the function fails with Timeout error.

val close_active_conns : ('a, 'b, 'c) Tezos_p2p.P2p_pool.t -> unit Lwt.t

close_active_conns pool@ closes all actives connections of the pool. This function waits until the connections are effectively closed.

val version : Tezos_base.Network_version.t
val conn_meta_config : unit Tezos_base.TzPervasives.P2p_params.conn_meta_config
val canceler : Lwt_canceler.t
val proof_of_work_target : Tezos_crypto.Crypto_box.pow_target
val id1 : Tezos_base.TzPervasives.P2p_identity.t Lwt.t
val id2 : Tezos_base.TzPervasives.P2p_identity.t Lwt.t
val run_nodes : addr:Tezos_base.TzPervasives.P2p_addr.t -> ?port:int -> ((unit, unit) Process.Channel.t -> Tezos_p2p.P2p_io_scheduler.t -> Ipaddr.V6.t -> int -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t) -> ((unit, unit) Process.Channel.t -> Tezos_p2p.P2p_io_scheduler.t -> Lwt_unix.file_descr -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t) -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t
val run_nodes_fd : addr:Tezos_base.TzPervasives.P2p_addr.t -> ?port:int -> ((unit, unit) Process.Channel.t -> Ipaddr.V6.t -> int -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t) -> ((unit, unit) Process.Channel.t -> Lwt_unix.file_descr -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t) -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t
val accept : ?id:Tezos_base.TzPervasives.P2p_identity.t Lwt.t -> ?proof_of_work_target:Tezos_crypto.Crypto_box.pow_target -> Tezos_p2p.P2p_io_scheduler.t -> Lwt_unix.file_descr -> (unit Tezos_base.TzPervasives.P2p_connection.Info.t * unit Tezos_p2p.P2p_socket.authenticated_connection, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t
val raw_connect : Tezos_p2p.P2p_io_scheduler.t -> Tezos_base.TzPervasives.P2p_addr.t -> int -> (Tezos_p2p.P2p_io_scheduler.connection, Tezos_p2p.P2p_fd.connect_error) result Lwt.t
val connect : ?proof_of_work_target:Tezos_crypto.Crypto_box.pow_target -> Tezos_p2p.P2p_io_scheduler.t -> Tezos_base.TzPervasives.P2p_addr.t -> int -> Tezos_base.TzPervasives.P2p_identity.t -> (unit Tezos_base.TzPervasives.P2p_connection.Info.t * unit Tezos_p2p.P2p_socket.authenticated_connection, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.t
val sync : (unit, unit) Process.Channel.t -> (unit, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace) result Lwt.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