package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a
doc/octez-shell-libs.shell/Tezos_shell/Distributed_db/Protocol/index.html
Module Distributed_db.Protocol
Source
Index of protocol sources.
include Tezos_requester.Requester.REQUESTER
with type t := db
and type key := Tezos_base.TzPervasives.Protocol_hash.t
and type value := Tezos_base.Protocol.t
and type param := unit
know t k
returns true iff the key is present in the memory table or the disk.
val read :
db ->
Tezos_base.TzPervasives.Protocol_hash.t ->
Tezos_base.Protocol.t Tezos_base.TzPervasives.tzresult Lwt.t
Return value if it is found in-memory, or else on disk. Otherwise fail with error Missing_data
.
val read_opt :
db ->
Tezos_base.TzPervasives.Protocol_hash.t ->
Tezos_base.Protocol.t option Lwt.t
Same as read
but returns None
if not found.
val inject :
db ->
Tezos_base.TzPervasives.Protocol_hash.t ->
Tezos_base.Protocol.t ->
bool Lwt.t
inject t k v
returns false
if k
is already present in the memory table or in the disk, or has already been requested. Otherwise it updates the memory table and return true
val fetch :
db ->
?peer:Tezos_base.TzPervasives.P2p_peer.Id.t ->
?timeout:Tezos_base.TzPervasives.Time.System.Span.t ->
Tezos_base.TzPervasives.Protocol_hash.t ->
unit ->
Tezos_base.Protocol.t Tezos_base.TzPervasives.tzresult Lwt.t
fetch t ?peer ?timeout k param
returns the value when it is known. It can fail with Timeout k
if timeout
is provided and the value isn't know before the timeout expires. It can fail with Cancel
if the request is canceled.
The key is first looked up in memory, then on disk. If not present and not already requested, it schedules a request, and blocks until the requester is notified with notify
. param
is used to validate the notified value once it is received. (see also PROBE
and notify
).
Requests are re-sent via a 1.5 exponential back-off, with initial delay set to Request.initial_delay
. If the function is called multiple time with the same key but with distinct peers, the internal scheduler randomly chooses the requested peer (at each retry).