Struct dfir_rs::util::simulation::Fleet

pub struct Fleet { /* private fields */ }

A fleet is a collection of hosts in the simulation. It is responsible for running the simulation and processing network messages.

Implementations

impl Fleet

pub fn new() -> Self

Creates a new instance of Fleet.

pub fn add_host<F>(&mut self, name: String, transducer_builder: F) -> &Host

where F: FnOnce(&mut TransducerBuilderContext<'_>) -> Dfir<'static>,

Adds a new host to the fleet with the given name and transducer.

pub fn get_host(&self, name: &str) -> Option<&Host>

Get a host by name.

pub fn get_host_mut(&mut self, name: &str) -> Option<&mut Host>

Get a host by name.

pub async fn run_single_tick_all_hosts(&mut self) -> bool

Advance time on all hosts by a single tick. Returns true if any work was done by any of the hosts. After ticking once on all the hosts, the method also processes network messages.

The order in which the ticks are processed is not guaranteed.

pub async fn process_network(&mut self)

Process all network messages in the simulation. This method picks up all messages from all outboxes on all hosts and delivers them to the corresponding inboxes on the destination.

The order in which the messages are processed is not guaranteed.

pub async fn run_until_quiescent(&mut self)

Tick all hosts until all hosts are quiescent (i.e. no new work is done by any host). Ticking is done in “rounds”. At each round, all hosts are ticked once and then network messages are processed. The process continues until no work is done by any host in a round.

Trait Implementations

impl Default for Fleet

fn default() -> Self

Returns the “default value” for a type.