Struct casper_node::effect::EffectBuilder

pub struct EffectBuilder<REv: 'static>(_);

A builder for Effects.

Provides methods allowing the creation of effects which need to be scheduled on the reactor's event queue, without giving direct access to this queue.

Implementations

impl<REv> EffectBuilder<REv>

pub fn new(event_queue_handle: EventQueueHandle<REv>) -> Self

Creates a new effect builder.

pub async fn immediately(self)

Run and end effect immediately.

Can be used to trigger events from effects when combined with .event. Do not use this do "do nothing", as it will still cause a task to be spawned.

pub async fn fatal<M: Display + ?Sized, '_, '_>(
    self,
    file: &'_ str,
    line: u32,
    msg: &'_ M
)

Reports a fatal error.

Usually causes the node to cease operations quickly and exit/crash.

pub async fn broadcast_message<I, P>(self, payload: P) where
    REv: From<NetworkRequest<I, P>>, 

Broadcasts a network message.

Broadcasts a network message to all peers connected at the time the message is sent.

pub async fn gossip_message<I, P>(
    self,
    payload: P,
    count: usize,
    exclude: HashSet<I>
) -> HashSet<I> where
    REv: From<NetworkRequest<I, P>>,
    I: Send + 'static,
    P: Send, 

Gossips a network message.

A low-level "gossip" function, selects count randomly chosen nodes on the network, excluding the indicated ones, and sends each a copy of the message.

Returns the IDs of the chosen nodes.

pub async fn network_peers<I>(self) -> HashMap<I, SocketAddr> where
    REv: From<NetworkInfoRequest<I>>,
    I: Send + 'static, 

Gets connected network peers.

Trait Implementations

impl<REv> Clone for EffectBuilder<REv>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<REv> Copy for EffectBuilder<REv>

impl<REv: Debug + 'static> Debug for EffectBuilder<REv>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.