docs for DNS_CACHE

meowjesty · Aug 18, 2023 · c464540 · c464540
1 parent d2703f7
commit c464540
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/mirrord/layer/src/socket/ops.rs b/mirrord/layer/src/socket/ops.rs
@@ -33,6 +33,10 @@ use crate::{
     OUTGOING_IGNORE_LOCALHOST, OUTGOING_SELECTOR, REMOTE_UNIX_STREAMS, TARGETLESS,
 };
 
+/// Holds the pair of [`SocketAddr`] with their hostnames, resolved through [`getaddrinfo`].
+///
+/// Used by [`connect_outgoing`] to retrieve the hostname from the address that the user called
+/// [`connect`] with, so we can resolve it locally when neccessary.
 pub(super) static DNS_CACHE: LazyLock<DashMap<SocketAddr, String>> =
     LazyLock::new(|| DashMap::with_capacity(8));