Struct hotshot_task_impls::request::NetworkRequestState

source ·
pub struct NetworkRequestState<TYPES: NodeType, I: NodeImplementation<TYPES>> {
    pub network: Arc<I::Network>,
    pub consensus: OuterConsensus<TYPES>,
    pub view: TYPES::View,
    pub delay: Duration,
    pub membership: TYPES::Membership,
    pub public_key: TYPES::SignatureKey,
    pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub id: u64,
    pub shutdown_flag: Arc<AtomicBool>,
    pub spawned_tasks: BTreeMap<TYPES::View, Vec<JoinHandle<()>>>,
}
Expand description

Long running task which will request information after a proposal is received. The task will wait a it’s delay and then send a request iteratively to peers for any data they don’t have related to the proposal. For now it’s just requesting VID shares.

Fields§

§network: Arc<I::Network>

Network to send requests over The underlying network

§consensus: OuterConsensus<TYPES>

Consensus shared state so we can check if we’ve gotten the information before sending a request

§view: TYPES::View

Last seen view, we won’t request for proposals before older than this view

§delay: Duration

Delay before requesting peers

§membership: TYPES::Membership

Membership (Here containing only DA)

§public_key: TYPES::SignatureKey

This nodes public key

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

This nodes private/signing key, used to sign requests.

§id: u64

The node’s id

§shutdown_flag: Arc<AtomicBool>

A flag indicating that HotShotEvent::Shutdown has been received

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

A flag indicating that HotShotEvent::Shutdown has been received

Implementations§

source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES>> NetworkRequestState<TYPES, I>

source

fn spawn_requests( &mut self, view: TYPES::View, epoch: TYPES::Epoch, sender: &Sender<Arc<HotShotEvent<TYPES>>>, receiver: &Receiver<Arc<HotShotEvent<TYPES>>>, )

Creates and signs the payload, then will create a request task

source

fn create_vid_request_task( &mut self, request: RequestKind<TYPES>, signature: <<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, sender: Sender<Arc<HotShotEvent<TYPES>>>, receiver: Receiver<Arc<HotShotEvent<TYPES>>>, view: TYPES::View, epoch: TYPES::Epoch, )

Creates a task that will request a VID share from a DA member and wait for the HotShotEvent::VidResponseRecvevent If we get the VID disperse share, broadcast HotShotEvent::VidShareRecv and terminate task

source

async fn handle_vid_request_task( sender: &Sender<Arc<HotShotEvent<TYPES>>>, receiver: &Receiver<Arc<HotShotEvent<TYPES>>>, data_request: &DataRequest<TYPES>, recipient: &TYPES::SignatureKey, da_committee_for_view: &BTreeSet<<TYPES as NodeType>::SignatureKey>, public_key: &<TYPES as NodeType>::SignatureKey, view: TYPES::View, ) -> bool

Handles main logic for the Request / Response of a vid share Make the request to get VID share to a DA member and wait for the response. Returns true if response received, otherwise false

source

async fn handle_event_dependency( receiver: &Receiver<Arc<HotShotEvent<TYPES>>>, da_members_for_view: BTreeSet<<TYPES as NodeType>::SignatureKey>, view: TYPES::View, ) -> Option<Arc<HotShotEvent<TYPES>>>

Create event dependency and wait for VidResponseRecv after we send out the request Returns an optional with VidResponseRecv if received, otherwise None

source

async fn cancel_vid_request_task( consensus: &OuterConsensus<TYPES>, sender: &Sender<Arc<HotShotEvent<TYPES>>>, public_key: &<TYPES as NodeType>::SignatureKey, view: &TYPES::View, shutdown_flag: &Arc<AtomicBool>, ) -> bool

Returns true if we got the data we wanted, a shutdown even was received, or the view has moved on.

source

fn serialize_and_sign( &self, request: &RequestKind<TYPES>, ) -> Option<<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType>

Sign the serialized version of the request

Trait Implementations§

source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES>> Drop for NetworkRequestState<TYPES, I>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES>> TaskState for NetworkRequestState<TYPES, I>

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> Freeze for NetworkRequestState<TYPES, I>
where <TYPES as NodeType>::View: Freeze, <TYPES as NodeType>::Membership: Freeze, <TYPES as NodeType>::SignatureKey: Freeze, <<TYPES as NodeType>::SignatureKey as SignatureKey>::PrivateKey: Freeze,

§

impl<TYPES, I> !RefUnwindSafe for NetworkRequestState<TYPES, I>

§

impl<TYPES, I> Send for NetworkRequestState<TYPES, I>

§

impl<TYPES, I> Sync for NetworkRequestState<TYPES, I>

§

impl<TYPES, I> Unpin for NetworkRequestState<TYPES, I>
where <TYPES as NodeType>::View: Unpin, <TYPES as NodeType>::Membership: Unpin, <TYPES as NodeType>::SignatureKey: Unpin, <<TYPES as NodeType>::SignatureKey as SignatureKey>::PrivateKey: Unpin,

§

impl<TYPES, I> !UnwindSafe for NetworkRequestState<TYPES, I>

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