Struct holochain::prelude::test_util::switchboard_state::Switchboard

pub struct Switchboard { /* private fields */ }

Wrapper around the shared state for a Switchboard network. This state represents the shared state across all nodes in a space.

This is essentially an Arc<Clone<SwitchboardState>>, which is passed to SwitchboardEventHandler and is also accessible to your test, so that you can manually modify state while gossip is modifying the same state.

When calling add_node(s), a new gossip module is created, a task is spawned to feed incoming network messages to the gossip module, and another task is spawned which handles the events received, mutating the state in the process.

Implementations

impl Switchboard

pub fn new(topology: Topology, gossip_type: GossipType) -> Switchboard

Constructor. Only works for one GossipType at a time.

pub fn share<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&mut SwitchboardState) -> R,

Simple infallible combinator around share_mut, more convenient for tests.

pub async fn add_nodes<const N: usize>(
    &self,
    tuning_params: Arc<KitsuneP2pTuningParams>
) -> impl Future<Output = [Tx2EpHnd<Wire>; N]>

Convenience for creating multiple nodes at once, easily destructurable using array syntax:

// no need to specify the number, the destructuring will deduce that.
let [n1, n2, n3] = sb.add_nodes();

pub async fn add_node(
    &self,
    tuning_params: Arc<KitsuneP2pTuningParams>
) -> impl Future<Output = Tx2EpHnd<Wire>>

Set up state and handler tasks for a new node in the space

Trait Implementations

impl Clone for Switchboard

fn clone(&self) -> Switchboard

Returns a copy of the value.

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

Performs copy-assignment from source.