package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/octez-shell-libs.p2p/Tezos_p2p/P2p_pool/Connection/index.html

Module P2p_pool.ConnectionSource

Sourceval fold : ('msg, 'peer, 'conn) t -> init:'a -> f: (Tezos_base.TzPervasives.P2p_peer.Id.t -> ('msg, 'peer, 'conn) P2p_conn.t -> 'a -> 'a) -> 'a

fold pool ~init ~f computes (f iN cN ... (f i1 c1 init)...) where id1 ... idN are the ids of every connected peers and c1 ... cN the associated peers info.

Sourceval iter : (Tezos_base.TzPervasives.P2p_peer.Id.t -> ('msg, 'peer, 'conn) P2p_conn.t -> unit) -> ('msg, 'peer, 'conn) t -> unit

iter f pool applies f to all connected peers of pool.

Sourceval list : ('msg, 'peer, 'conn) t -> (Tezos_base.TzPervasives.P2p_peer.Id.t * ('msg, 'peer, 'conn) P2p_conn.t) list
Sourceval find_by_point : ('msg, 'peer, 'conn) t -> Tezos_base.TzPervasives.P2p_point.Id.t -> ('msg, 'peer, 'conn) P2p_conn.t option
Sourceval find_by_peer_id : ('msg, 'peer, 'conn) t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> ('msg, 'peer, 'conn) P2p_conn.t option
Sourceval random_addr : ?different_than:('msg, 'peer, 'conn) P2p_conn.t -> no_private:bool -> ('msg, 'peer, 'conn) t -> (Tezos_base.TzPervasives.P2p_point.Id.t * Tezos_base.TzPervasives.P2p_peer.Id.t) option

random_addr ?conn no_private t returns a random (point_id, peer_id) from the pool of connections. It ignores:

  • connections to private peers if no_private is set to true
  • connection conn
  • connections to peers who didn't provide a listening port at session-establishment
Sourceval propose_swap_request : ('msg, 'peer, 'conn) t -> (Tezos_base.TzPervasives.P2p_point.Id.t * Tezos_base.TzPervasives.P2p_peer.Id.t * ('msg, 'peer, 'conn) P2p_conn.t) option

propose_swap_request t returns a triple (point_id, peer_id, conn) where conn is a random connection to a non-private peer, and (point_id, peer_id) is a random, different, connected peer_id at point_id.