Struct TimeoutParams 

pub struct TimeoutParams {
    pub propose: Option<Duration>,
    pub propose_delta: Option<Duration>,
    pub vote: Option<Duration>,
    pub vote_delta: Option<Duration>,
}

TimeoutParams configure the timeouts for the steps of the Tendermint consensus algorithm.

Fields

propose: Option<Duration>

These fields configure the timeouts for the propose step of the Tendermint consensus algorithm: propose is the initial timeout and propose_delta determines how much the timeout grows in subsequent rounds. For the first round, this propose timeout is used and for every subsequent round, the timeout grows by propose_delta.

For example: With propose = 10ms, propose_delta = 5ms, the first round’s propose phase timeout would be 10ms, the second round’s would be 15ms, the third 20ms and so on.

If a node waiting for a proposal message does not receive one matching its current height and round before this timeout, the node will issue a nil prevote for the round and advance to the next step.

propose_delta: Option<Duration>

vote: Option<Duration>

vote along with vote_delta configure the timeout for both of the prevote and precommit steps of the Tendermint consensus algorithm.

These parameters influence the vote step timeouts in the the same way that the propose and propose_delta parameters do to the proposal step.

The vote timeout does not begin until a quorum of votes has been received. Once a quorum of votes has been seen and this timeout elapses, Tendermint will procced to the next step of the consensus algorithm. If Tendermint receives all of the remaining votes before the end of the timeout, it will proceed to the next step immediately.

vote_delta: Option<Duration>

Trait Implementations

impl Clone for TimeoutParams

fn clone(&self) -> TimeoutParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimeoutParams

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

Formats the value using the given formatter.

impl Default for TimeoutParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeoutParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TimeoutParams

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for TimeoutParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TimeoutParams

fn eq(&self, other: &TimeoutParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TimeoutParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TimeoutParams

impl Eq for TimeoutParams

impl StructuralPartialEq for TimeoutParams