Merge pull request #9 from eskimor/rk-document-IpvPacketInfo

Document usage of IP_PKTINFO
bltavares · Sep 16, 2020 · 42893cd · 42893cd
2 parents 44a3d55 + d4e581f
commit 42893cd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/unix.rs b/src/unix.rs
@@ -19,6 +19,9 @@ fn create_on_interfaces(
     socket.set_reuse_address(true)?;
     socket.set_reuse_port(true)?;
 
+    // Ipv4PacketInfo translates to `IP_PKTINFO`. Checkout the [ip
+    // manpage](https://man7.org/linux/man-pages/man7/ip.7.html) for more details. In summary
+    // setting this option allows for determining on which interface a packet was received.
     sock::setsockopt(socket.as_raw_fd(), sock::sockopt::Ipv4PacketInfo, &true)
         .map_err(nix_to_io_error)?;