package octez-shell-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez shell libraries

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.1.tar.gz

sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d

sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/octez-shell-libs.p2p/Tezos_p2p/P2p_discovery/index.html

Module `Tezos_p2p.P2p_discovery`Source

Local peer discovery.

This module manages the discovery of local peers through UDP broadcasting. It is composed of two workers:

The sender worker whose role is to broadcast discovery messages.
The answer worker whose role is to listen discovery messages and register new peers in the current pool. Discovery messages are composed of an arbitrary key, the listening port and the peer id of the current peer.

Sourcetype t

Type of a discovery worker.

Source

val create : 
  listening_port:int ->
  discovery_port:int ->
  discovery_addr:Ipaddr.V4.t ->
  trust_discovered_peers:bool ->
  ('a, 'b, 'c) P2p_pool.t ->
  Tezos_base.TzPervasives.P2p_peer.Table.key ->
  t

create ~listening_port ~discovery_port ~discovery_addr pool peer_id returns a discovery worker registering local peers to the pool and broadcasting discovery messages with the peer_id and the listening_port through the address discovery_addr:discovery_port.

Sourceval activate : t -> unit

Sourceval wakeup : t -> unit

wakeup t sends a signal to the sender machine of t, asking it to immediately proceed to broadcasting.

Sourceval shutdown : t -> unit Lwt.t

shutdown t returns when t has completed shutdown.