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

octez-19.1.tar.gz

sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e

sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

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.