Struct NetworkLayer 

pub struct NetworkLayer {
    pub(crate) swarm: Swarm<P2PBehaviour>,
    pub(crate) command_receiver: UnboundedReceiver<NetworkCommand>,
    pub(crate) pending_requests: HashMap<OutboundRequestId, Sender<NetworkResponse>>,
    pub(crate) sync_event_tx: Option<UnboundedSender<SyncEvent>>,
    pub(crate) ui_notify_tx: Option<UnboundedSender<UiNotification>>,
    pub(crate) mailbox_storage: Option<Arc<SledMailboxStore>>,
    pub(crate) blocked_peers: HashMap<PeerId, Instant>,
}

The state of the network layer.

This struct holds all the necessary components for the network layer to function, such as the libp2p Swarm, channels for communication with other parts of the application, and storage.

Fields

swarm: Swarm<P2PBehaviour>

The libp2p Swarm.

command_receiver: UnboundedReceiver<NetworkCommand>

The receiver for network commands.

pending_requests: HashMap<OutboundRequestId, Sender<NetworkResponse>>

A map of pending outbound requests.

sync_event_tx: Option<UnboundedSender<SyncEvent>>

The sender for synchronization events.

ui_notify_tx: Option<UnboundedSender<UiNotification>>

The sender for UI notifications.

mailbox_storage: Option<Arc<SledMailboxStore>>

The storage for the mailbox.

blocked_peers: HashMap<PeerId, Instant>

A map of peers that are currently blocked.

Implementations

impl NetworkLayer

pub(super) async fn handle_command( &mut self, command: NetworkCommand, ) -> Result<()>

Handles an incoming NetworkCommand.

This function processes commands sent to the NetworkLayer from other parts of the application.

Arguments

• command - The NetworkCommand to handle.

Errors

This function will return an error if handling the command fails.

impl NetworkLayer

pub(super) async fn handle_chat_event( &mut self, event: Event<ChatRequest, ChatResponse>, incoming_messages: &UnboundedSender<Message>, ) -> Result<()>

Handles an event from the ChatBehaviour.

This function is called when an event is received from the ChatBehaviour. It dispatches the event to the appropriate handler.

Arguments

• event - The request_response::Event<ChatRequest, ChatResponse> to handle.
• incoming_messages - The sender for incoming chat messages.

Errors

This function will return an error if handling the event fails.

async fn handle_chat_request( &mut self, request: ChatRequest, channel: ResponseChannel<ChatResponse>, incoming_messages: &UnboundedSender<Message>, ) -> Result<()>

Handles an inbound chat request.

async fn handle_chat_response( &mut self, request_id: OutboundRequestId, response: ChatResponse, ) -> Result<()>

Handles an outbound chat response.

impl NetworkLayer

pub(super) async fn handle_discovery_event( &mut self, event: DiscoveryBehaviourEvent, ) -> Result<()>

Handles an event from the DiscoveryBehaviour.

This function is called when an event is received from the DiscoveryBehaviour. It dispatches the event to the appropriate handler.

Arguments

• event - The DiscoveryBehaviourEvent to handle.

Errors

This function will return an error if handling the event fails.

async fn handle_kademlia_event(&mut self, event: Event) -> Result<()>

Handles a Kademlia event.

impl NetworkLayer

pub(super) async fn handle_mailbox_event( &mut self, event: Event<MailboxRequest, MailboxResponse>, ) -> Result<()>

Handles an event from the MailboxBehaviour.

This function is called when an event is received from the MailboxBehaviour. It dispatches the event to the appropriate handler.

Arguments

• event - The request_response::Event<MailboxRequest, MailboxResponse> to handle.

Errors

This function will return an error if handling the event fails.

async fn handle_mailbox_request( &mut self, request: MailboxRequest, channel: ResponseChannel<MailboxResponse>, ) -> Result<()>

Handles an inbound mailbox request.

async fn handle_mailbox_response( &mut self, request_id: OutboundRequestId, response: MailboxResponse, ) -> Result<()>

Handles an outbound mailbox response.

impl NetworkLayer

pub(crate) async fn handle_swarm_event( &mut self, event: SwarmEvent<P2PBehaviourEvent>, incoming_messages: &UnboundedSender<Message>, ) -> Result<()>

Handles a SwarmEvent.

This function is the main entry point for handling events from the libp2p Swarm. It dispatches the event to the appropriate handler based on its type.

Arguments

• event - The SwarmEvent<P2PBehaviourEvent> to handle.
• incoming_messages - The sender for incoming chat messages.

Errors

This function will return an error if handling the event fails.

impl NetworkLayer

pub fn new( identity: Arc<Identity>, listen_addr: Multiaddr, is_mailbox: bool, bootstrap_nodes: Vec<&str>, ) -> Result<(Self, NetworkHandle)>

Creates a new NetworkLayer and NetworkHandle.

Arguments

• identity - The identity of the local node.
• listen_addr - The address to listen on for incoming connections.
• is_mailbox - Whether the node is a mailbox node.
• bootstrap_nodes - A list of bootstrap nodes to connect to.

Errors

This function will return an error if the network layer cannot be created.

pub fn new_with_mailbox_storage( identity: Arc<Identity>, listen_addr: Multiaddr, is_mailbox: bool, mailbox_storage: Option<Arc<SledMailboxStore>>, bootstrap_nodes: Vec<&str>, ) -> Result<(Self, NetworkHandle)>

Creates a new NetworkLayer and NetworkHandle with optional mailbox storage.

Arguments

• identity - The identity of the local node.
• listen_addr - The address to listen on for incoming connections.
• is_mailbox - Whether the node is a mailbox node.
• mailbox_storage - The storage for the mailbox, if this is a mailbox node.
• bootstrap_nodes - A list of bootstrap nodes to connect to.

Errors

This function will return an error if the network layer cannot be created.

impl NetworkLayer

pub fn set_sync_event_sender(&mut self, sender: UnboundedSender<SyncEvent>)

Sets the sender for synchronization events.

pub fn set_ui_notify_sender(&mut self, sender: UnboundedSender<UiNotification>)

Sets the sender for UI notifications.

pub fn bootstrap_dht(&mut self) -> Result<()>

Bootstraps the Kademlia DHT.

Errors

This function will return an error if the bootstrap process fails.

pub fn start_providing_mailbox(&mut self) -> Result<()>

Starts providing the general mailbox provider key in the Kademlia DHT.

Errors

This function will return an error if the providing process fails to start.

pub fn start_providing_for_recipient( &mut self, recipient_hash: [u8; 32], ) -> Result<()>

Starts providing a key for a specific recipient in the Kademlia DHT.

Arguments

• recipient_hash - The hash of the recipient’s public key.

Errors

This function will return an error if the providing process fails to start.

impl NetworkLayer

fn cleanup_blocked_peers(&mut self)

Periodically cleans up the list of blocked peers.

pub async fn run( &mut self, incoming_messages: UnboundedSender<Message>, ) -> Result<()>

Runs the main event loop for the NetworkLayer.

This function listens for events from the libp2p Swarm and for commands from other parts of the application. It also periodically cleans up the list of blocked peers.

Arguments

• incoming_messages - The sender for incoming chat messages.

Errors

This function will return an error if the event loop fails.