package tezos-p2p

You can search for identifiers within the package.

in-package search v0.2.0

package tezos-p2p

tezos-p2p
- Tezos_p2p
  - P2p
  - P2p_acl
    
    IPBlacklist
    
    IPGreylist
    
    IpTable
    
    Legacy
    
    PeerBlacklist
    
    PeerFIFOCache
    
    PeerGreylist
  - P2p_answerer
  - P2p_conn
  - P2p_connect_handler
  - P2p_directory
  - P2p_discovery
  - P2p_events
    
    Discovery
    
    P2p
    
    P2p_conn
    
    P2p_connect_handler
    
    P2p_fd
    
    P2p_io_scheduler
    
    P2p_maintainance
    
    P2p_pool
    
    P2p_protocol
    
    P2p_socket
    
    P2p_welcome
  - P2p_fd
    
    Table
    
    Legacy
  - P2p_io_scheduler
    
    Internal
  - P2p_maintenance
  - P2p_message
  - P2p_params
  - P2p_peer_state
    
    Info
    
    File
  - P2p_point_state
    
    Info
  - P2p_pool
    
    Connection
    
    Peers
    
    Points
  - P2p_protocol
  - P2p_socket
  - P2p_trigger
  - P2p_welcome

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

type t

Type of a discovery worker.

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

val activate : t -> unit

val wakeup : t -> unit

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

val shutdown : t -> unit Lwt.t

shutdown t returns when t has completed shutdown.