Parcourir la source

[5377] Updated documentation of the send() function in pkt_filter_inet.

Marcin Siodelski il y a 7 ans
Parent
commit
126006de15
1 fichiers modifiés avec 7 ajouts et 0 suppressions
  1. 7 0
      src/lib/dhcp/pkt_filter_inet.h

+ 7 - 0
src/lib/dhcp/pkt_filter_inet.h

@@ -67,6 +67,13 @@ public:
 
     /// @brief Send packet over specified socket.
     ///
+    /// This function will use local address specified in the @c pkt as a source
+    /// address for the packet and the interface index to select the index
+    /// through which the packet will be sent. However, if these values
+    /// are not specified for the packet (zero IP address and negative
+    /// interface index), this function will rely on the routing information
+    /// to determine the right outbound interface and source address.
+    ///
     /// @param iface interface to be used to send packet
     /// @param sockfd socket descriptor
     /// @param pkt packet to be sent