package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-shell-libs.p2p_test_common/Tezos_p2p_test_common/P2p_test_utils/index.html

Module Tezos_p2p_test_common.P2p_test_utilsSource

This module provides functions used for tests.

Sourcetype '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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

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.

Sourceval 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.

Sourceval canceler : Lwt_canceler.t
Sourceval proof_of_work_target : Tezos_crypto.Crypto_box.pow_target
Sourceval 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
OCaml

Innovation. Community. Security.