Struct nakamoto_net::simulator::Simulation

pub struct Simulation<T>where
    T: StateMachine,{ /* private fields */ }

A peer-to-peer node simulation.

Implementations

impl<T> Simulation<T>where
    T: StateMachine + 'static,
    T::DisconnectReason: Clone + Into<Disconnect<T::DisconnectReason>>,
    <T::Message as ToOwned>::Owned: Debug + Clone,

pub fn new(time: LocalTime, rng: Rng, opts: Options) -> Self

Create a new simulation.

pub fn is_done(&self) -> bool

Check whether the simulation is done, ie. there are no more messages to process.

pub fn elapsed(&self) -> LocalDuration

Total amount of simulated time elapsed.

pub fn is_settled(&self) -> bool

Check whether the simulation has settled, ie. the only messages left to process are (periodic) timeouts.

pub fn events(&mut self, node: &IpAddr) -> impl Iterator<Item = T::Event> + '_

Get a node’s emitted events.

pub fn latency(&self, from: IpAddr, to: IpAddr) -> LocalDuration

Get the latency between two nodes. The minimum latency between nodes is 1 millisecond.

pub fn initialize<'a, P: Peer<T>>(
    self,
    peers: impl IntoIterator<Item = &'a mut P>
) -> Self

Initialize peers.

pub fn run_while<'a, P: Peer<T>>(
    &mut self,
    peers: impl IntoIterator<Item = &'a mut P>,
    pred: impl Fn(&Self) -> bool
)

Run the simulation while the given predicate holds.

pub fn step<'a, P: Peer<T>>(
    &mut self,
    peers: impl IntoIterator<Item = &'a mut P>
) -> bool

Process one scheduled input from the inbox, using the provided peers. This function should be called until it returns false, or some desired state is reached. Returns true if there are more messages to process.

pub fn schedule(
    &mut self,
    node: &IpAddr,
    out: Io<<T::Message as ToOwned>::Owned, T::Event, T::DisconnectReason, SocketAddr>
)

Process a protocol output event from a node.