From: JINMEI Tatuya <jinmei@wide.ad.jp>
Date: Sun, 1 Nov 2015 01:53:18 +0000 (+0900)
Subject: [4108] added doc for the new method, adjusted it for run() accordingly.
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d3d3ac5a76e8a6507da1b684dc7c9e330b57e221;p=thirdparty%2Fkea.git

[4108] added doc for the new method, adjusted it for run() accordingly.
---

diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h
index 62f0a855ca..b59f75c516 100644
--- a/src/bin/dhcp4/dhcp4_srv.h
+++ b/src/bin/dhcp4/dhcp4_srv.h
@@ -201,15 +201,21 @@ public:
  
     /// @brief Main server processing loop.
     ///
-    /// Main server processing loop. Receives incoming packets, verifies
-    /// their correctness, generates appropriate answer (if needed) and
-    /// transmits responses.
+    /// Main server processing loop. Receives incoming packets, and calls
+    /// processPakcet for each of them.
     ///
     /// @return true, if being shut down gracefully, fail if experienced
     ///         critical error.
     bool run();
 
-    void processPacket(Pkt4Ptr& packet);
+    /// @brief Process a single incoming DHCPv4 packet.
+    ///
+    /// It verifies correctness of the passed packet, call per-type processXXX
+    /// methods, generates appropriate answer (if needed) and (if necessary)
+    /// transmits a response.
+    ///
+    /// @param query A pointer to the packet to be processed.
+    void processPacket(Pkt4Ptr& query);
 
     /// @brief Instructs the server to shut down.
     void shutdown();