Struct ConsensusBasedTotalOrderBroadcast 

pub struct ConsensusBasedTotalOrderBroadcast<V: Clone + Ord, L: VolatileLink<Carried<V>> = PerfectLink<Carried<V>>> { /* private fields */ }

A totally ordered log, agreed by one consensus instance per round.

Implementations

impl<V: Clone + Ord> ConsensusBasedTotalOrderBroadcast<V>

pub fn new( me: NodeId, peers: impl IntoIterator<Item = NodeId>, timing: Timing, ) -> Self

A totally ordered log among peers, over perfect links.

timing is the consensus beneath’s: its detect_after must exceed heartbeat plus the network’s delivery bound, or the perfect failure detector under flooding consensus accuses a correct process and agreement can break.

impl<V: Clone + Ord, L: VolatileLink<Carried<V>>> ConsensusBasedTotalOrderBroadcast<V, L>

pub fn entries(&self) -> &[Slot<V>]

The agreed sequence as this process holds it.

pub fn len(&self) -> usize

How many entries this process has ordered.

pub fn is_empty(&self) -> bool

pub fn round(&self) -> u64

The round this process is running.

pub fn instances(&self) -> usize

How many consensus instances are held. Grows with rounds, and is never pruned — see the module’s space statement.

Trait Implementations

impl<V: Clone + Ord, L: VolatileLink<Carried<V>>> Protocol for ConsensusBasedTotalOrderBroadcast<V, L>

type Meta = Infallible

Keeps nothing durably. The fail-recovery variant is the one that does.

type Cmd = Cmd<V>

Requests from the layer above.

type Ind = Ind<V>

Indications to the layer above — this protocol delivering on its guarantee.

type Msg = Wire<<BestEffortBroadcast<Data<V>, L> as Protocol>::Msg, <FloodingConsensus<BTreeSet<(NodeId, V)>> as Protocol>::Msg>

What crosses the wire to a peer running the same protocol.

type Scope = Infallible

Scopes whose boundaries this protocol’s guarantees depend on, and which it can observe.

type Note = Note

The vocabulary in which this protocol narrates its decisions.

type Entry = Infallible

The durable entries this protocol appends: what accumulates.

fn on_cmd(&mut self, cmd: Cmd<V>, cx: &mut ProtoCx<'_, Self>)

Handle a request from the layer above.

fn on_msg(&mut self, from: NodeId, msg: Self::Msg, cx: &mut ProtoCx<'_, Self>)

Handle a message received from from.

fn on_timer(&mut self, id: TimerId, cx: &mut ProtoCx<'_, Self>)

Handle a timer that fired somewhere in this protocol or in what it composes.

fn on_init(&mut self, cx: &mut ProtoCx<'_, Self>)

Begin, on a first start — when nothing has been written down.

fn on_recovery( &mut self, _cx: &mut Cx<'_, Self::Msg, Self::Ind, Self::Note, Self::Meta, Self::Entry>, )

Resume after a crash, reading what survived.

fn on_scope_event( &mut self, _scope: Self::Scope, _cx: &mut Cx<'_, Self::Msg, Self::Ind, Self::Note, Self::Meta, Self::Entry>, )

Handle a boundary of a scope this protocol’s guarantees depend on — its end, or the beginning of the one that succeeds it.

impl<V: Clone + Ord, L: VolatileLink<Carried<V>>> TotalOrderLog<V> for ConsensusBasedTotalOrderBroadcast<V, L>

fn append(value: V) -> Cmd<V>

The request that appends value to the log.

fn read(from: Position) -> Cmd<V>

The request that reads the ordered sequence from from onwards.

fn classify(ind: Ind<V>) -> LogInd<V>

What this indication means to the layer above.