package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-shell-libs.p2p/Tezos_p2p/P2p_conn/index.html
Module Tezos_p2p.P2p_connSource
Type of a connection to a peer, parametrized by the type of messages exchanged as well as meta-information associated to a peer and a connection. It wraps a P2p_socket.t, adding meta-information and data-structures describing a more fine-grained logical state of the connection. It also set up an answering worker that responds to the messages P2p_message.t using the callback functions of a P2p_answerer.t.
val create :
conn:('msg P2p_message.t, 'conn) P2p_socket.t ->
point_info:('msg, 'peer, 'conn) t P2p_point_state.Info.t option ->
peer_info:(('msg, 'peer, 'conn) t, 'peer, 'conn) P2p_peer_state.Info.t ->
messages:(int * 'msg) Tezos_stdlib.Lwt_pipe.Maybe_bounded.t ->
canceler:Lwt_canceler.t ->
greylister:(unit -> unit) ->
callback:'msg P2p_answerer.t ->
disable_peer_discovery:bool ->
Tezos_base.TzPervasives.Network_version.t ->
('msg, 'peer, 'conn) tprivate_node t returns 'true' if the node associated to this connection is in private mode
trusted_node t returns 'true' if the node associated to this connection is trusted
stat t is a snapshot of current bandwidth usage for t.
read t returns a message popped from t's app message queue, or fails with Connection_closed.
is_readable t returns when there is at least one message ready to be read.
val write_swap_request :
('msg, 'peer, 'conn) t ->
Tezos_base.TzPervasives.P2p_point.Id.t ->
Tezos_base.TzPervasives.P2p_peer.Id.t ->
bool Tezos_base.TzPervasives.tzresultval write_swap_ack :
('msg, 'peer, 'conn) t ->
Tezos_base.TzPervasives.P2p_point.Id.t ->
Tezos_base.TzPervasives.P2p_peer.Id.t ->
bool Tezos_base.TzPervasives.tzresultwrite t msg is P2p_socket.write t' msg where t' is the internal P2p_socket.t inside t.
val write_sync :
('msg, 'peer, 'conn) t ->
'msg ->
unit Tezos_base.TzPervasives.tzresult Lwt.twrite_sync t msg is P2p_socket.write_sync t' msg where t' is the internal P2p_socket.t inside t.
write_now t msg is P2p_socket.write_now t' msg where t' is the internal P2p_socket.t inside t.
val encode :
('msg, 'peer, 'conn) t ->
'msg ->
'msg P2p_message.t P2p_socket.encoded_message
Tezos_base.TzPervasives.tzresultencode t messsage encodes a message to be used with write_encoded_now. It is particularly useful to avoid encoding several times the same message.
val write_encoded_now :
('msg, 'peer, 'conn) t ->
'msg P2p_message.t P2p_socket.encoded_message ->
bool Tezos_base.TzPervasives.tzresultwrite_encoded_now t msg is P2p_socket.write_now t' msg where t' is the internal P2p_socket.t inside t and msg has been pre-encoded using encode. msg will be overwritten and should not be used after this invocation.
Returns the network version that will be used for this connection. This network version is the best version compatible with the versions supported by ours and the remote peer.