Struct hbbft::binary_agreement::BinaryAgreement

pub struct BinaryAgreement<N, S> { /* fields omitted */ }

Binary Agreement instance

Methods

impl<N: NodeIdT, S: SessionIdT> BinaryAgreement<N, S>

pub fn new(netinfo: Arc<NetworkInfo<N>>, session_id: S) -> Result<Self>

Creates a new BinaryAgreement instance with the given session identifier, to prevent replaying messages in other instances.

pub fn propose(&mut self, input: bool) -> Result<Step<N>>

Proposes a boolean value for Binary Agreement.

If more than two thirds of validators propose the same value, that will eventually be output. Otherwise either output is possible.

Note that if can_propose returns false, it is already too late to affect the outcome.

pub fn handle_message(&mut self, sender_id: &N, msg: Message) -> Result<Step<N>>

Handles a message received from sender_id.

This must be called with every message we receive from another node.

pub fn can_propose(&self) -> bool

Whether we can still input a value. It is not an error to input if this returns false, but it will have no effect on the outcome.

Trait Implementations

impl<N: NodeIdT, S: SessionIdT> ConsensusProtocol for BinaryAgreement<N, S>

type NodeId = N

Unique node identifier.

type Input = bool

The input provided by the user.

type Output = bool

The output type. Some algorithms return an output exactly once, others return multiple times.

type Message = Message

The messages that need to be exchanged between the instances in the participating nodes.

type Error = Error

The errors that can occur during execution.

type FaultKind = FaultKind

The kinds of message faults that can be detected during execution.

fn handle_input<R: Rng>(
    &mut self,
    input: Self::Input,
    _rng: &mut R
) -> Result<Step<N>>

Handles an input provided by the user, and returns

fn handle_message<R: Rng>(
    &mut self,
    sender_id: &Self::NodeId,
    message: Message,
    _rng: &mut R
) -> Result<Step<N>>

Receive input from a remote node.

fn terminated(&self) -> bool

Whether the algorithm has terminated.

fn our_id(&self) -> &Self::NodeId

Returns this node's own ID.

impl<N: NodeIdT, S: SessionIdT> Display for BinaryAgreement<N, S>

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<N: Debug, S: Debug> Debug for BinaryAgreement<N, S>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.