Struct sn_networking::SwarmDriver

pub struct SwarmDriver { /* private fields */ }

SwarmDriver is responsible for managing the swarm of peers, handling swarm events, processing commands, and maintaining the state of pending tasks. It serves as the core component for the network functionality.

Implementations

impl SwarmDriver

pub fn handle_msg( &mut self, event: Event<Request, Response> ) -> Result<(), Error>

Forwards Request to the upper layers using Sender<NetworkEvent>. Sends Response to the peers

impl SwarmDriver

pub fn new( keypair: Keypair, addr: SocketAddr, local: bool, root_dir: PathBuf ) -> Result<(Network, Receiver<NetworkEvent>, Self), Error>

Creates a new SwarmDriver instance, along with a Network handle for sending commands and an mpsc::Receiver<NetworkEvent> for receiving network events. It initializes the swarm, sets up the transport, and configures the Kademlia and mDNS behaviour for peer discovery.

Returns

A tuple containing a Network handle, an mpsc::Receiver<NetworkEvent>, and a SwarmDriver instance.

Errors

Returns an error if there is a problem initializing the mDNS behaviour.

pub fn new_client( local: bool, request_timeout: Option<Duration> ) -> Result<(Network, Receiver<NetworkEvent>, Self), Error>

Same as new API but creates the network components in client mode

pub async fn run(self)

Asynchronously drives the swarm event loop, handling events from both the swarm and command receiver. This function will run indefinitely, until the command channel is closed.

The tokio::select macro is used to concurrently process swarm events and command receiver messages, ensuring efficient handling of multiple asynchronous tasks.