Correct naming (ip vs addr)

Author: DanglingPointer

mtorrent-utils/src/upnp.rs

@@ -72,7 +72,7 @@ impl PortOpener {
     }
 
     /// Get the external socket address that was mapped to the internal port.
-    pub fn external_ip(&self) -> SocketAddr {
+    pub fn external_addr(&self) -> SocketAddr {
         self.external_addr
     }
 
@@ -146,7 +146,7 @@ mod tests {
         let port_opener = PortOpener::new(PortMappingProtocol::TCP, internal_port, None, None)
             .await
             .unwrap_or_else(|e| panic!("Failed to create PortOpener: {e}"));
-        log::info!("port opener created, external ip: {}", port_opener.external_ip());
+        log::info!("port opener created, external ip: {}", port_opener.external_addr());
         time::sleep(sec!(1)).await;
         drop(port_opener);
         log::info!("port opener dropped");

mtorrent/src/app/dht.rs

@@ -63,7 +63,7 @@ async fn start_upnp(local_port: u16, interface: Option<&str>) -> io::Result<()>
     .await
     .map_err(io::Error::other)?;
 
-    log::info!("UPnP for DHT succeeded, public ip: {}", port_opener.external_ip());
+    log::info!("UPnP for DHT succeeded, public ip: {}", port_opener.external_addr());
 
     // start periodic renewal of port mapping. It will stop and remove the mapping
     // automatically once the DHT runtime shuts down

mtorrent/src/app/main.rs

@@ -53,10 +53,10 @@ struct Handles<'h> {
 #[derive(Clone)]
 struct Params {
     local_peer_id: PeerId,
-    listener_port: u16,
-    pwp_external_port: u16,
-    pwp_local_addr_v4: Ipv4Addr,
-    pwp_local_addr_v6: Ipv6Addr,
+    internal_pwp_port: u16,
+    external_pwp_port: u16,
+    local_ip_v4: Ipv4Addr,
+    local_ip_v6: Ipv6Addr,
     bind_interface: Option<String>,
 }
 
@@ -74,7 +74,7 @@ async fn start_upnp(
         return internal_port;
     };
 
-    let external_addr = port_opener.external_ip();
+    let external_addr = port_opener.external_addr();
     log::info!("UPnP: {proto:?} port mapping succeeded, public addr: {external_addr}");
 
     task::spawn(async move {
@@ -103,37 +103,38 @@ pub async fn single_torrent(
     }
     let ctx: &Context = ctx.borrow();
 
-    let listener_port = cfg.pwp_port.unwrap_or_else(|| net::port_from_hash(&metainfo_uri.as_ref()));
-    let pwp_local_addr_v4 = net::get_bind_addr_v4(cfg.bind_interface.as_deref());
-    let pwp_local_addr_v6 = net::get_bind_addr_v6(cfg.bind_interface.as_deref());
+    let internal_pwp_port =
+        cfg.pwp_port.unwrap_or_else(|| net::port_from_hash(&metainfo_uri.as_ref()));
+    let local_addr_v4 = net::get_bind_addr_v4(cfg.bind_interface.as_deref());
+    let local_addr_v6 = net::get_bind_addr_v6(cfg.bind_interface.as_deref());
 
     // create port mappings and get external port to send correct listening port to trackers and
     // peers later
     let external_pwp_port = if cfg.use_upnp {
         let _g = ctx.pwp_runtime.enter();
-        let (_public_pwp_port, public_utp_port) = join!(
+        let (_external_tcp_port, external_udp_port) = join!(
             start_upnp(
-                listener_port,
+                internal_pwp_port,
                 cfg.pwp_port,
                 upnp::PortMappingProtocol::TCP,
                 cfg.bind_interface.as_deref()
             ),
             start_upnp(
-                listener_port,
+                internal_pwp_port,
                 cfg.pwp_port,
                 upnp::PortMappingProtocol::UDP,
                 cfg.bind_interface.as_deref()
             ),
         );
-        public_utp_port
+        external_udp_port
     } else {
-        listener_port
+        internal_pwp_port
     };
 
     let utp_handle = ops::launch_utp(
         &ctx.pwp_runtime,
-        SocketAddrV4::new(pwp_local_addr_v4, listener_port),
-        SocketAddrV6::new(pwp_local_addr_v6, listener_port, 0, 0),
+        SocketAddrV4::new(local_addr_v4, internal_pwp_port),
+        SocketAddrV6::new(local_addr_v6, internal_pwp_port, 0, 0),
         cfg.bind_interface.clone(),
     );
 
@@ -152,10 +153,10 @@ pub async fn single_torrent(
 
     let params = Params {
         local_peer_id: cfg.local_peer_id,
-        listener_port,
-        pwp_external_port: external_pwp_port,
-        pwp_local_addr_v4,
-        pwp_local_addr_v6,
+        internal_pwp_port,
+        external_pwp_port,
+        local_ip_v4: local_addr_v4,
+        local_ip_v6: local_addr_v6,
         bind_interface: cfg.bind_interface,
     };
 
@@ -220,10 +221,10 @@ async fn preliminary_stage(
     let ctx = ops::PreliminaryCtx::new(
         magnet_link,
         params.local_peer_id,
-        params.pwp_external_port,
-        params.listener_port,
-        params.pwp_local_addr_v4,
-        params.pwp_local_addr_v6,
+        params.external_pwp_port,
+        params.internal_pwp_port,
+        params.local_ip_v4,
+        params.local_ip_v6,
         params.bind_interface.clone(),
     );
 
@@ -250,13 +251,13 @@ async fn preliminary_stage(
             info_hash,
             dht_cmds.clone(),
             peer_reporter.clone(),
-            params.pwp_external_port,
+            params.external_pwp_port,
         ))
     });
 
     tasks.spawn_on(
         ops::run_pwp_listener(
-            SocketAddr::new(params.pwp_local_addr_v4.into(), params.listener_port),
+            SocketAddr::new(params.local_ip_v4.into(), params.internal_pwp_port),
             params.bind_interface.clone(),
             peer_reporter.clone(),
         ),
@@ -265,7 +266,7 @@ async fn preliminary_stage(
 
     tasks.spawn_on(
         ops::run_pwp_listener(
-            SocketAddr::new(params.pwp_local_addr_v6.into(), params.listener_port),
+            SocketAddr::new(params.local_ip_v6.into(), params.internal_pwp_port),
             params.bind_interface,
             peer_reporter.clone(),
         ),
@@ -320,10 +321,10 @@ async fn main_stage(
     let ctx: ops::Handle<_> = ops::MainCtx::new(
         metainfo,
         params.local_peer_id,
-        params.pwp_external_port,
-        params.listener_port,
-        params.pwp_local_addr_v4,
-        params.pwp_local_addr_v6,
+        params.external_pwp_port,
+        params.internal_pwp_port,
+        params.local_ip_v4,
+        params.local_ip_v6,
         params.bind_interface.clone(),
     )?;
 
@@ -353,13 +354,13 @@ async fn main_stage(
             info_hash,
             dht_cmds.clone(),
             peer_reporter.clone(),
-            params.pwp_external_port,
+            params.external_pwp_port,
         ))
     });
 
     tasks.spawn_on(
         ops::run_pwp_listener(
-            SocketAddr::new(params.pwp_local_addr_v4.into(), params.listener_port),
+            SocketAddr::new(params.local_ip_v4.into(), params.internal_pwp_port),
             params.bind_interface.clone(),
             peer_reporter.clone(),
         ),
@@ -368,7 +369,7 @@ async fn main_stage(
 
     tasks.spawn_on(
         ops::run_pwp_listener(
-            SocketAddr::new(params.pwp_local_addr_v6.into(), params.listener_port),
+            SocketAddr::new(params.local_ip_v6.into(), params.internal_pwp_port),
             params.bind_interface,
             peer_reporter.clone(),
         ),

mtorrent/src/ops/ctx.rs

@@ -55,8 +55,8 @@ pub(super) struct ConstData {
     local_peer_id: PeerId,
     pwp_external_port: u16,
     pwp_internal_port: u16,
-    pwp_local_addr_v4: Ipv4Addr,
-    pwp_local_addr_v6: Ipv6Addr,
+    local_ip_v4: Ipv4Addr,
+    local_ip_v6: Ipv6Addr,
     bind_interface: Option<String>,
     outbound_pwp_mode: PwpMode,
 }
@@ -71,11 +71,11 @@ impl ConstData {
     pub(super) fn pwp_internal_port(&self) -> u16 {
         self.pwp_internal_port
     }
-    pub(super) fn pwp_local_addr_v4(&self) -> Ipv4Addr {
-        self.pwp_local_addr_v4
+    pub(super) fn local_ip_v4(&self) -> Ipv4Addr {
+        self.local_ip_v4
     }
-    pub(super) fn pwp_local_addr_v6(&self) -> Ipv6Addr {
-        self.pwp_local_addr_v6
+    pub(super) fn local_ip_v6(&self) -> Ipv6Addr {
+        self.local_ip_v6
     }
     pub(super) fn bind_interface(&self) -> Option<&str> {
         self.bind_interface.as_deref()
@@ -103,8 +103,8 @@ impl PreliminaryCtx {
         local_peer_id: PeerId,
         pwp_external_port: u16,
         pwp_internal_port: u16,
-        pwp_local_addr_v4: Ipv4Addr,
-        pwp_local_addr_v6: Ipv6Addr,
+        local_ip_v4: Ipv4Addr,
+        local_ip_v6: Ipv6Addr,
         bind_interface: Option<String>,
     ) -> Handle<Self> {
         Handle::new(Self {
@@ -117,8 +117,8 @@ impl PreliminaryCtx {
                 local_peer_id,
                 pwp_external_port,
                 pwp_internal_port,
-                pwp_local_addr_v4,
-                pwp_local_addr_v6,
+                local_ip_v4,
+                local_ip_v6,
                 bind_interface,
                 outbound_pwp_mode: get_outbound_pwp_mode(),
             },
@@ -142,8 +142,8 @@ impl MainCtx {
         local_peer_id: PeerId,
         pwp_external_port: u16,
         pwp_internal_port: u16,
-        pwp_local_addr_v4: Ipv4Addr,
-        pwp_local_addr_v6: Ipv6Addr,
+        local_ip_v4: Ipv4Addr,
+        local_ip_v6: Ipv6Addr,
         bind_interface: Option<String>,
     ) -> io::Result<Handle<Self>> {
         fn make_error(s: &'static str) -> impl FnOnce() -> io::Error {
@@ -170,8 +170,8 @@ impl MainCtx {
                 local_peer_id,
                 pwp_external_port,
                 pwp_internal_port,
-                pwp_local_addr_v4,
-                pwp_local_addr_v6,
+                local_ip_v4,
+                local_ip_v6,
                 bind_interface,
                 outbound_pwp_mode: get_outbound_pwp_mode(),
             },
@@ -295,8 +295,8 @@ impl ConstData {
             local_peer_id: PeerId::generate_new(),
             pwp_external_port: 12345,
             pwp_internal_port: 0,
-            pwp_local_addr_v4: Ipv4Addr::LOCALHOST,
-            pwp_local_addr_v6: Ipv6Addr::LOCALHOST,
+            local_ip_v4: Ipv4Addr::LOCALHOST,
+            local_ip_v6: Ipv6Addr::LOCALHOST,
             bind_interface: None,
             outbound_pwp_mode: PwpMode::Any,
         }

mtorrent/src/ops/peer/tcp.rs

@@ -18,8 +18,8 @@ pub async fn new_outbound_connection(
     pwp_runtime: &runtime::Handle,
 ) -> io::Result<(pwp::DownloadChannels, pwp::UploadChannels, Option<pwp::ExtendedChannels>)> {
     let local_addr = match &peer_addr {
-        SocketAddr::V4(_) => data.pwp_local_addr_v4().into(),
-        SocketAddr::V6(_) => data.pwp_local_addr_v6().into(),
+        SocketAddr::V4(_) => data.local_ip_v4().into(),
+        SocketAddr::V6(_) => data.local_ip_v6().into(),
     };
 
     let local_peer_id = *data.local_peer_id();