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>
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> NetworkRequestState<TYPES, I>
sourcefn spawn_requests(
&mut self,
view: TYPES::View,
epoch: TYPES::Epoch,
sender: &Sender<Arc<HotShotEvent<TYPES>>>,
receiver: &Receiver<Arc<HotShotEvent<TYPES>>>,
)
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
sourcefn 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,
)
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::VidResponseRecv
event
If we get the VID disperse share, broadcast HotShotEvent::VidShareRecv
and terminate task
sourceasync 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
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
sourceasync 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>>>
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
sourceasync 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
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.
sourcefn serialize_and_sign(
&self,
request: &RequestKind<TYPES>,
) -> Option<<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType>
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>
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> Drop for NetworkRequestState<TYPES, I>
source§impl<TYPES: NodeType, I: NodeImplementation<TYPES>> TaskState for NetworkRequestState<TYPES, I>
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> TaskState for NetworkRequestState<TYPES, I>
source§type Event = HotShotEvent<TYPES>
type Event = HotShotEvent<TYPES>
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,
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,
source§fn cancel_subtasks(&mut self)
fn cancel_subtasks(&mut self)
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.