Struct hotshot_task_impls::quorum_proposal_recv::QuorumProposalRecvTaskState

pub struct QuorumProposalRecvTaskState<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {

    pub public_key: TYPES::SignatureKey,
    pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub consensus: OuterConsensus<TYPES>,
    pub cur_view: TYPES::View,
    pub cur_epoch: TYPES::Epoch,
    pub membership: Arc<RwLock<TYPES::Membership>>,
    pub timeout: u64,
    pub output_event_stream: Sender<Event<TYPES>>,
    pub storage: Arc<RwLock<I::Storage>>,
    pub spawned_tasks: BTreeMap<TYPES::View, Vec<JoinHandle<()>>>,
    pub id: u64,
    pub upgrade_lock: UpgradeLock<TYPES, V>,
    pub epoch_height: u64,
}

The state for the quorum proposal task. Contains all of the information for handling HotShotEvent::QuorumProposalRecv events.

Fields

public_key: TYPES::SignatureKey

Our public key

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

Our Private Key

consensus: OuterConsensus<TYPES>

Reference to consensus. The replica will require a write lock on this.

cur_view: TYPES::View

View number this view is executing in.

cur_epoch: TYPES::Epoch

Epoch number this node is executing in.

membership: Arc<RwLock<TYPES::Membership>>

Membership for Quorum Certs/votes

timeout: u64

View timeout from config.

output_event_stream: Sender<Event<TYPES>>

Output events to application

storage: Arc<RwLock<I::Storage>>

This node’s storage ref

spawned_tasks: BTreeMap<TYPES::View, Vec<JoinHandle<()>>>

Spawned tasks related to a specific view, so we can cancel them when they are stale

id: u64

The node’s id

upgrade_lock: UpgradeLock<TYPES, V>

Lock for a decided upgrade

epoch_height: u64

Number of blocks in an epoch, zero means there are no epochs

Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> QuorumProposalRecvTaskState<TYPES, I, V>

pub fn cancel_tasks(&mut self, view: TYPES::View)

Cancel all tasks the consensus tasks has spawned before the given view

pub async fn handle( &mut self, event: Arc<HotShotEvent<TYPES>>, event_sender: Sender<Arc<HotShotEvent<TYPES>>>, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, )

Handles all consensus events relating to propose and vote-enabling events.

Trait Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> TaskState for QuorumProposalRecvTaskState<TYPES, I, 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.