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-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

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

Module Tezos_p2p.P2p_point_stateSource

Sourcetype 'conn t =
  1. | Requested of {
    1. cancel : Lwt_canceler.t;
    }
    (*

    We initiated a connection.

    *)
  2. | Accepted of {
    1. current_peer_id : Tezos_base.TzPervasives.P2p_peer.Id.t;
    2. cancel : Lwt_canceler.t;
    }
    (*

    We accepted a incoming connection.

    *)
  3. | Running of {
    1. data : 'conn;
    2. current_peer_id : Tezos_base.TzPervasives.P2p_peer.Id.t;
    }
    (*

    Successfully authenticated connection, normal business.

    *)
  4. | Disconnected
    (*

    No connection established currently.

    *)
Sourcetype 'conn state = 'conn t
Sourceval pp : Format.formatter -> 'conn t -> unit
Sourcemodule Info : sig ... end
Sourceval get : 'conn Info.t -> 'conn t
Sourceval is_running : 'conn Info.t -> bool
Sourceval is_disconnected : 'conn Info.t -> bool
Sourceval is_accepted : 'conn Info.t -> bool
Sourceval set_requested : timestamp:Tezos_base.TzPervasives.Time.System.t -> 'conn Info.t -> Lwt_canceler.t -> unit
Sourceval set_running : timestamp:Tezos_base.TzPervasives.Time.System.t -> 'conn Info.t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> 'conn -> unit
Sourceval set_private : 'conn Info.t -> bool -> unit
Sourceval set_disconnected : timestamp:Tezos_base.TzPervasives.Time.System.t -> ?requested:bool -> Tezos_p2p_services.Point_reconnection_config.t -> 'conn Info.t -> unit
Sourceval set_expected_peer_id : 'conn Info.t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> unit

set_expected_peer_id point_info peer_id associates an expected peer_id to point_info.

Sourceval get_expected_peer_id : 'conn Info.t -> Tezos_base.TzPervasives.P2p_peer.Id.t option
Sourceval info_of_point_info : 'conn Info.t -> Tezos_base.TzPervasives.P2p_point.Info.t