From: Marcin Siodelski <marcin@isc.org>
Date: Fri, 6 Oct 2017 10:56:52 +0000 (+0200)
Subject: [5377] Updated documentation of the send() function in pkt_filter_inet.
X-Git-Tag: trac5297_base~15^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=126006de15cc610ddceea366e90c53f2abd3e116;p=thirdparty%2Fkea.git

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

diff --git a/src/lib/dhcp/pkt_filter_inet.h b/src/lib/dhcp/pkt_filter_inet.h
index aef7a8f62c..6cc9fecb4e 100644
--- a/src/lib/dhcp/pkt_filter_inet.h
+++ b/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