docs

Author: Frando

iroh/src/magicsock.rs

@@ -272,7 +272,7 @@ impl MagicSock {
     /// The actor is responsible for holepunching and opening additional paths to this
     /// connection.
     ///
-    /// Returns a future that resolves to [`PathsWatchable`].
+    /// Returns a future that resolves to [`PathsWatcher`].
     ///
     /// The returned future is `'static`, so it can be stored without being liftetime-bound to `&self`.
     pub(crate) fn register_connection(

iroh/src/magicsock/endpoint_map/endpoint_state.rs

@@ -1133,14 +1133,18 @@ impl ConnectionState {
 ///
 /// This is stored in the [`Connection`], and the watchables are set from within the endpoint state actor.
 ///
+/// Internally, this contains a boxed-mapped-joined watcher over the open paths in the connection and the
+/// selected path to the remote endpoint. The watcher is boxed because the mapped-joined watcher with
+/// `SmallVec<PathInfoList>` has a size of over 800 bytes, which we don't want to put upon the [`Connection`].
+///
 /// [`Connection`]: crate::endpoint::Connection
 #[derive(Clone, derive_more::Debug)]
 #[debug("PathsWatcher")]
 pub(crate) struct PathsWatcher(
     Box<
         n0_watcher::Map<
             (
-                n0_watcher::Direct<SmallVec<[(TransportAddr, PathId); 4]>>,
+                n0_watcher::Direct<PathAddrList>,
                 n0_watcher::Direct<Option<transports::Addr>>,
             ),
             PathInfoList,