pub struct QuorumProposalTaskState<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {
Show 14 fields pub latest_proposed_view: TYPES::View, pub proposal_dependencies: BTreeMap<TYPES::View, JoinHandle<()>>, pub instance_state: Arc<TYPES::InstanceState>, pub quorum_membership: Arc<TYPES::Membership>, pub public_key: TYPES::SignatureKey, pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey, pub timeout: u64, pub storage: Arc<RwLock<I::Storage>>, pub consensus: OuterConsensus<TYPES>, pub id: u64, pub formed_upgrade_certificate: Option<UpgradeCertificate<TYPES>>, pub upgrade_lock: UpgradeLock<TYPES, V>, pub epoch_height: u64, pub highest_qc: QuorumCertificate2<TYPES>,
}
Expand description

The state for the quorum proposal task.

Fields§

§latest_proposed_view: TYPES::View

Latest view number that has been proposed for.

§proposal_dependencies: BTreeMap<TYPES::View, JoinHandle<()>>

Table for the in-progress proposal dependency tasks.

§instance_state: Arc<TYPES::InstanceState>

Immutable instance state

§quorum_membership: Arc<TYPES::Membership>

Membership for Quorum Certs/votes

§public_key: TYPES::SignatureKey

Our public key

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

Our Private Key

§timeout: u64

View timeout from config.

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

This node’s storage ref

§consensus: OuterConsensus<TYPES>

Shared consensus task state

§id: u64

The node’s id

§formed_upgrade_certificate: Option<UpgradeCertificate<TYPES>>

The most recent upgrade certificate this node formed. Note: this is ONLY for certificates that have been formed internally, so that we can propose with them.

Certificates received from other nodes will get reattached regardless of this fields, since they will be present in the leaf we propose off of.

§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

§highest_qc: QuorumCertificate2<TYPES>

The highest_qc we’ve seen at the start of this task

Implementations§

source§

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

source

fn create_event_dependency( &self, dependency_type: ProposalDependency, view_number: TYPES::View, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, ) -> EventDependency<Arc<HotShotEvent<TYPES>>>

Create an event dependency

source

fn create_and_complete_dependencies( &self, view_number: TYPES::View, event_receiver: &Receiver<Arc<HotShotEvent<TYPES>>>, event: Arc<HotShotEvent<TYPES>>, ) -> AndDependency<Vec<Vec<Arc<HotShotEvent<TYPES>>>>>

Creates the requisite dependencies for the Quorum Proposal task. It also handles any event forwarding.

source

fn create_dependency_task_if_new( &mut self, view_number: TYPES::View, epoch_number: TYPES::Epoch, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, event_sender: Sender<Arc<HotShotEvent<TYPES>>>, event: Arc<HotShotEvent<TYPES>>, ) -> Result<()>

Create and store an AndDependency combining EventDependencys associated with the given view number if it doesn’t exist. Also takes in the received event to seed a dependency as already completed. This allows for the task to receive a proposable event without losing the data that it received, as the dependency task would otherwise have no ability to receive the event and, thus, would never propose.

source

async fn update_latest_proposed_view(&mut self, new_view: TYPES::View) -> bool

Update the latest proposed view number.

source

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

Handles a consensus event received on the event stream

source

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

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

Trait Implementations§

source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> TaskState for QuorumProposalTaskState<TYPES, I, V>

source§

type Event = HotShotEvent<TYPES>

Type of event sent and received by the task
source§

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.
source§

fn cancel_subtasks(&mut self)

Joins all subtasks.

Auto Trait Implementations§

§

impl<TYPES, I, V> Freeze for QuorumProposalTaskState<TYPES, I, V>

§

impl<TYPES, I, V> !RefUnwindSafe for QuorumProposalTaskState<TYPES, I, V>

§

impl<TYPES, I, V> Send for QuorumProposalTaskState<TYPES, I, V>

§

impl<TYPES, I, V> Sync for QuorumProposalTaskState<TYPES, I, V>

§

impl<TYPES, I, V> Unpin for QuorumProposalTaskState<TYPES, I, V>
where <TYPES as NodeType>::View: Unpin, <TYPES as NodeType>::SignatureKey: Unpin, <<TYPES as NodeType>::SignatureKey as SignatureKey>::PrivateKey: Unpin, V: Unpin, <<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Unpin, TYPES: Unpin,

§

impl<TYPES, I, V> !UnwindSafe for QuorumProposalTaskState<TYPES, I, V>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T