Struct hotshot_task_impls::network::test::NetworkEventTaskStateModifier

pub struct NetworkEventTaskStateModifier<TYPES: NodeType, V: Versions, NET: ConnectedNetwork<TYPES::SignatureKey>, S: Storage<TYPES>> {
    pub network_event_task_state: NetworkEventTaskState<TYPES, V, NET, S>,
    pub modifier: Arc<ModifierClosure<TYPES>>,
}

A helper wrapper around NetworkEventTaskState that can modify its behaviour for tests

Fields

network_event_task_state: NetworkEventTaskState<TYPES, V, NET, S>

The real NetworkEventTaskState

modifier: Arc<ModifierClosure<TYPES>>

A function that takes the result of NetworkEventTaskState::parse_event and changes it before transmitting on the network.

Implementations

impl<TYPES: NodeType, V: Versions, NET: ConnectedNetwork<TYPES::SignatureKey>, S: Storage<TYPES> + 'static> NetworkEventTaskStateModifier<TYPES, V, NET, S>

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

Handles the received event modifying it before sending on the network.

Methods from Deref<Target = NetworkEventTaskState<TYPES, V, NET, S>>

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

Handle the given event.

Returns the completion status.

async fn handle_vid_disperse_proposal( &self, vid_proposal: Proposal<TYPES, VidDisperse<TYPES>>, sender: &<TYPES as NodeType>::SignatureKey, ) -> Option<HotShotTaskCompleted>

handle VidDisperseSend

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

Cancel all tasks for previous views

async fn parse_event( &mut self, event: Arc<HotShotEvent<TYPES>>, maybe_action: &mut Option<HotShotAction>, ) -> Option<(<TYPES as NodeType>::SignatureKey, MessageKind<TYPES>, TransmitType<TYPES>)>

Parses a HotShotEvent and returns a tuple of: (sender’s public key, MessageKind, TransmitType) which will be used to create a message and transmit on the wire. Returns None if the parsing result should not be sent on the wire. Handles the VidDisperseSend event separately using a helper method.

fn spawn_transmit_task( &mut self, message_kind: MessageKind<TYPES>, maybe_action: Option<HotShotAction>, transmit: TransmitType<TYPES>, sender: TYPES::SignatureKey, )

Creates a network message and spawns a task that transmits it on the wire.

Trait Implementations

impl<TYPES: NodeType, V: Versions, NET: ConnectedNetwork<TYPES::SignatureKey>, S: Storage<TYPES>> Deref for NetworkEventTaskStateModifier<TYPES, V, NET, S>

type Target = NetworkEventTaskState<TYPES, V, NET, S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<TYPES: NodeType, V: Versions, NET: ConnectedNetwork<TYPES::SignatureKey>, S: Storage<TYPES>> DerefMut for NetworkEventTaskStateModifier<TYPES, V, NET, S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<TYPES: NodeType, V: Versions, NET: ConnectedNetwork<TYPES::SignatureKey>, S: Storage<TYPES> + 'static> TaskState for NetworkEventTaskStateModifier<TYPES, V, NET, S>

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.