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

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

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

Module Tezos_p2p.P2p_answererSource

An Answerer.t is a set of callback functions, parameterized by conn_info record. The conn_info records contains values useful for the callback functions to perform their task, and known after the connection is set up.

The callback functions are called when the node receives `P2p_messages.t` messages. The parameters are the values carried by the message, and a request_info record that contains values pertaining to the connection that may change during the life of the connection.

Sourcetype 'msg conn_info = {
  1. peer_id : Tezos_base.TzPervasives.P2p_peer.Id.t;
  2. is_private : bool;
  3. write_advertise : Tezos_base.TzPervasives.P2p_point.Id.t list -> bool Tezos_base.TzPervasives.tzresult;
    (*

    write_advertise points must send the message Advertise(points) to the internal peer_id. It must return Ok true if the message has been successfully sent, Ok false if the message has been dropped, or fails with a corresponding error otherwise.

    *)
  4. write_swap_ack : Tezos_base.TzPervasives.P2p_point.Id.t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> bool Tezos_base.TzPervasives.tzresult;
    (*

    write_swap_ack (p1, p2) must send the message Swap_ack(p1, p2) to the internal peer_id. It must return Ok true if the message has been successfully sent, Ok false if the message has been dropped, or fails with a corresponding error otherwise.

    *)
  5. messages : (int * 'msg) Tezos_stdlib.Lwt_pipe.Maybe_bounded.t;
}
Sourcetype request_info = {
  1. last_sent_swap_request : (Tezos_base.TzPervasives.Time.System.t * Tezos_base.TzPervasives.P2p_peer.Id.t) option;
}
Sourcetype 'msg callback = {
  1. bootstrap : request_info -> unit Tezos_base.TzPervasives.tzresult Lwt.t;
  2. advertise : request_info -> Tezos_base.TzPervasives.P2p_point.Id.t list -> unit Lwt.t;
  3. message : request_info -> int -> 'msg -> unit Lwt.t;
  4. swap_request : request_info -> Tezos_base.TzPervasives.P2p_point.Id.t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> unit Lwt.t;
  5. swap_ack : request_info -> Tezos_base.TzPervasives.P2p_point.Id.t -> Tezos_base.TzPervasives.P2p_peer.Id.t -> unit Lwt.t;
}
Sourcetype 'msg t = 'msg conn_info -> 'msg callback