Struct ViewSyncTaskState

pub struct ViewSyncTaskState<TYPES: NodeType, V: Versions> {

    pub cur_view: TYPES::View,
    pub next_view: TYPES::View,
    pub cur_epoch: Option<TYPES::Epoch>,
    pub membership_coordinator: EpochMembershipCoordinator<TYPES>,
    pub public_key: TYPES::SignatureKey,
    pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub id: u64,
    pub num_timeouts_tracked: u64,
    pub replica_task_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, ViewSyncReplicaTaskState<TYPES, V>>>>,
    pub pre_commit_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncPreCommitVote2<TYPES>, ViewSyncPreCommitCertificate2<TYPES>, V>>>>>,
    pub commit_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncCommitVote2<TYPES>, ViewSyncCommitCertificate2<TYPES>, V>>>>>,
    pub finalize_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncFinalizeVote2<TYPES>, ViewSyncFinalizeCertificate2<TYPES>, V>>>>>,
    pub view_sync_timeout: Duration,
    pub last_garbage_collected_view: TYPES::View,
    pub upgrade_lock: UpgradeLock<TYPES, V>,
    pub first_epoch: Option<(TYPES::View, TYPES::Epoch)>,
    pub highest_finalized_epoch_view: (Option<TYPES::Epoch>, TYPES::View),
    pub epoch_height: u64,
}

Main view sync task state

Fields

cur_view: TYPES::View

View HotShot is currently in

next_view: TYPES::View

View HotShot wishes to be in

cur_epoch: Option<TYPES::Epoch>

Epoch HotShot is currently in

membership_coordinator: EpochMembershipCoordinator<TYPES>

Membership for the quorum

public_key: TYPES::SignatureKey

This Nodes Public Key

private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey

Our Private Key

id: u64

Our node id; for logging

num_timeouts_tracked: u64

How many timeouts we’ve seen in a row; is reset upon a successful view change

replica_task_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, ViewSyncReplicaTaskState<TYPES, V>>>>

Map of running replica tasks

pre_commit_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncPreCommitVote2<TYPES>, ViewSyncPreCommitCertificate2<TYPES>, V>>>>>

Map of pre-commit vote accumulates for the relay

commit_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncCommitVote2<TYPES>, ViewSyncCommitCertificate2<TYPES>, V>>>>>

Map of commit vote accumulates for the relay

finalize_relay_map: RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, BTreeMap<u64, VoteCollectionTaskState<TYPES, ViewSyncFinalizeVote2<TYPES>, ViewSyncFinalizeCertificate2<TYPES>, V>>>>>

Map of finalize vote accumulates for the relay

view_sync_timeout: Duration

Timeout duration for view sync rounds

last_garbage_collected_view: TYPES::View

Last view we garbage collected old tasks

upgrade_lock: UpgradeLock<TYPES, V>

Lock for a decided upgrade

first_epoch: Option<(TYPES::View, TYPES::Epoch)>

First view in which epoch version takes effect

highest_finalized_epoch_view: (Option<TYPES::Epoch>, TYPES::View)

Keeps track of the highest finalized view and epoch, used for garbage collection

epoch_height: u64

Implementations

impl<TYPES: NodeType, V: Versions> ViewSyncTaskState<TYPES, V>

pub async fn send_to_or_create_replica( &mut self, event: Arc<HotShotEvent<TYPES>>, view: TYPES::View, epoch: Option<TYPES::Epoch>, sender: &Sender<Arc<HotShotEvent<TYPES>>>, )

Handles incoming events for the main view sync task

pub async fn handle( &mut self, event: Arc<HotShotEvent<TYPES>>, event_stream: Sender<Arc<HotShotEvent<TYPES>>>, ) -> Result<()>

Handles incoming events for the main view sync task

async fn garbage_collect_tasks(&self)

Garbage collect tasks for epochs older than the highest finalized epoch or older than the previous epoch, whichever is greater. Garbage collect views older than the highest finalized view including the highest finalized view.

async fn garbage_collect_tasks_helper<VAL>( map: &RwLock<BTreeMap<Option<<TYPES as NodeType>::Epoch>, BTreeMap<<TYPES as NodeType>::View, VAL>>>, gc_epoch: &Option<TYPES::Epoch>, gc_view: &TYPES::View, )

Trait Implementations

impl<TYPES: NodeType, V: Versions> TaskState for ViewSyncTaskState<TYPES, V>

type Event = HotShotEvent<TYPES>

Type of event sent and received by the task

fn handle_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, event: Arc<Self::Event>, sender: &'life1 Sender<Arc<Self::Event>>, _receiver: &'life2 Receiver<Arc<Self::Event>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handles an event, providing direct access to the specific channel we received the event on.

fn cancel_subtasks(&mut self)

Joins all subtasks.