Enum Msg 

pub enum Msg<Ctx: Context> {
    StartHeight(Ctx::Height, HeightParams<Ctx>),
    NetworkEvent(NetworkEvent<Ctx>),
    TimeoutElapsed(TimeoutElapsed<Timeout>),
    ProposeValue(LocallyProposedValue<Ctx>),
    ReceivedProposedValue(ProposedValue<Ctx>, ValueOrigin),
    ProcessSyncResponse(ValueResponse<Ctx>),
    RestartHeight(Ctx::Height, HeightParams<Ctx>),
    DumpState(RpcReplyPort<Option<StateDump<Ctx>>>),
}

Variants

StartHeight(Ctx::Height, HeightParams<Ctx>)

Start consensus for the given height and provided parameters.

NetworkEvent(NetworkEvent<Ctx>)

Received an event from the gossip layer

TimeoutElapsed(TimeoutElapsed<Timeout>)

A timeout has elapsed

ProposeValue(LocallyProposedValue<Ctx>)

The proposal builder has built a value and can be used in a new proposal consensus message

ReceivedProposedValue(ProposedValue<Ctx>, ValueOrigin)

Received and assembled the full value proposed by a validator

ProcessSyncResponse(ValueResponse<Ctx>)

Process a sync response

RestartHeight(Ctx::Height, HeightParams<Ctx>)

Instructs consensus to restart at a given height with the provided parameters.

On this input consensus resets the Write-Ahead Log.

Warning

This operation should be used with extreme caution as it can lead to safety violations:

1. The application must clean all state associated with the height for which commit has failed
2. Since consensus resets its write-ahead log, the node may equivocate on proposals and votes for the restarted height, potentially violating protocol safety

DumpState(RpcReplyPort<Option<StateDump<Ctx>>>)

Request to dump the current consensus state

Trait Implementations

impl<Ctx: Context> Debug for Msg<Ctx>

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Ctx: Context> Display for Msg<Ctx>

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

Formats the value using the given formatter.

impl<Ctx: Context> From<NetworkEvent<Ctx>> for Msg<Ctx>

fn from(event: NetworkEvent<Ctx>) -> Self

Converts to this type from the input type.

impl<Ctx: Context> From<TimeoutElapsed<Timeout>> for Msg<Ctx>

fn from(msg: TimeoutElapsed<Timeout>) -> Self

Converts to this type from the input type.