Module `P2p_taps_lwt.Make`

Functor building an implementation of Taps with Lwt given a Node_id, Node, gossip View, Taps implementation, and an Io event handler module.

Parameters

Node_id : P2p.S.NODE_ID
Node : P2p.S.NODE with type nid := Node_id.t
View : P2p.S.VIEW with type nid := Node_id.t and type node := Node.t
Taps : P2p.S.GOSSIP with type node := Node.t and type view := View.t
Io : S.TAPS_IO with type nid := Node_id.t and type node := Node.t and type view := View.t

Signature

type t
type nid
type node
type view
type io

val init : me:node -> view:view -> view_len:int -> xchg_len:int -> period:float -> io:io -> t

init node view view_len xchg_len period io initializes a TAPS instance

parameter me: this node

parameter view: initial TAPS view

parameter xview: explicit view

parameter view_len: max view length

parameter xchg_len: number of entries to exchange at each period

parameter period: gossip period, in seconds

parameter io: network I/O implementation

val run : ?⁠stop:unit Lwt.t -> t -> unit Lwt.t

run t runs initiator thread: picks a random node from view to gossip with every period seconds.

If ?stop is provided, this initiator thread returns as soon as the stop thread is fulfilled.

val shutdown : t -> unit

shutdown t stops initiator thread.

In case run was called with a stop argument, the stop thread is cancelled, otherwise it is fulfilled.

val respond : t -> node -> view -> view Lwt.t: respond t src recvd merges received entries from a node and sends response

val view : t -> view: view t returns current view