documented protocol address behavior

src/net/protocols/protocol_address.rs

@@ -8,7 +8,7 @@ use crate::net::messages;
 use crate::net::protocols::{ProtocolJobsManager, ProtocolJobsManagerPtr};
 use crate::net::{ChannelPtr, HostsPtr};
 
-/// Address protocol.
+/// Protocol for address and get-address messages.
 pub struct ProtocolAddress {
     channel: ChannelPtr,
 
@@ -21,13 +21,17 @@ pub struct ProtocolAddress {
 }
 
 impl ProtocolAddress {
+    /// Create a new address protocol. Makes an address and get-address subscription and adds them
+    /// to the address protocol instance.
     pub async fn new(channel: ChannelPtr, hosts: HostsPtr) -> Arc<Self> {
+        // Creates a subscription to address message.
         let addrs_sub = channel
             .clone()
             .subscribe_msg::<messages::AddrsMessage>()
             .await
             .expect("Missing addrs dispatcher!");
 
+        // Creates a subscription to get-address message.
         let get_addrs_sub = channel
             .clone()
             .subscribe_msg::<messages::GetAddrsMessage>()
@@ -43,6 +47,8 @@ impl ProtocolAddress {
         })
     }
 
+    /// Starts the address protocol. Runs receive address and get address protocols on the protocol
+    /// task manager. Then sends get-address message.
     pub async fn start(self: Arc<Self>, executor: Arc<Executor<'_>>) {
         debug!(target: "net", "ProtocolAddress::start() [START]");
         self.jobsman.clone().start(executor.clone());
@@ -55,12 +61,14 @@ impl ProtocolAddress {
             .spawn(self.clone().handle_receive_get_addrs(), executor)
             .await;
 
-        // Send get_address message
+        // Send get_address message.
         let get_addrs = messages::GetAddrsMessage {};
         let _ = self.channel.clone().send(get_addrs).await;
         debug!(target: "net", "ProtocolAddress::start() [END]");
     }
 
+    /// Handles receiving the address message. Loops to continually recieve address messages on the
+    /// address subsciption. Adds the recieved addresses to the list of hosts.
     async fn handle_receive_addrs(self: Arc<Self>) -> NetResult<()> {
         debug!(target: "net", "ProtocolAddress::handle_receive_addrs() [START]");
         loop {
@@ -78,6 +86,8 @@ impl ProtocolAddress {
         }
     }
 
+    /// Handles receiving the get-address message. Continually recieves get-address messages on the 
+    /// get-address subsciption. Then replies with an address message.
     async fn handle_receive_get_addrs(self: Arc<Self>) -> NetResult<()> {
         debug!(target: "net", "ProtocolAddress::handle_receive_get_addrs() [START]");
         loop {
@@ -85,13 +95,16 @@ impl ProtocolAddress {
 
             debug!(target: "net", "ProtocolAddress::handle_receive_get_addrs() received GetAddrs message");
 
+            // Loads the list of hosts.
             let addrs = self.hosts.load_all().await;
             debug!(
                 target: "net",
                 "ProtocolAddress::handle_receive_get_addrs() sending {} addrs",
                 addrs.len()
             );
+            // Creates an address messages containing host address.
             let addrs_msg = messages::AddrsMessage { addrs };
+            // Sends the address message across the channel.
             self.channel.clone().send(addrs_msg).await?;
         }
     }