Struct PacemakerState

struct PacemakerState {
    timeouts: BTreeMap<ViewNumber, Instant>,
    timeout_vote_collectors: ActiveCollectorPair<TimeoutVoteCollector>,
    last_advance_view: Option<ViewNumber>,
}

Internal state of the Pacemaker. Keeps track of the timeouts allocated to current and future views (if any), and the timeout votes collected for the current view.

Fields

timeouts: BTreeMap<ViewNumber, Instant>

timeout_vote_collectors: ActiveCollectorPair<TimeoutVoteCollector>

last_advance_view: Option<ViewNumber>

Implementations

impl PacemakerState

fn initialize( config: &PacemakerConfiguration, init_view: ViewNumber, validator_set_state: &ValidatorSetState, ) -> Self

Initializes the PacemakerState on starting the protocol. Should only be called at the start of the protocol.

fn initial_timeouts( start_view: ViewNumber, config: &PacemakerConfiguration, ) -> BTreeMap<ViewNumber, Instant>

Return initial timeouts on starting the protocol from a given start view.

fn set_timeouts( &mut self, start_view: ViewNumber, config: &PacemakerConfiguration, )

Set the timeout for each view in the epoch starting from a given view.

fn extend_epoch_view_timeout( &mut self, epoch_view: ViewNumber, config: &PacemakerConfiguration, )

Extend the timeout of the epoch-change view by another max_view_time.

Required: The caller must ensure that the view is an epoch-change view.