From: Tomek Mrugalski <tomasz@isc.org>
Date: Wed, 16 May 2018 12:42:55 +0000 (+0200)
Subject: [5564] Changes after review:
X-Git-Tag: trac5549a_base~14^2~1^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=92e83eb2c8a3b66cee42dba3d8a74fa056f51378;p=thirdparty%2Fkea.git

[5564] Changes after review:

 - dumpPackets renamed to discardPackets
 - added missing comments
---

diff --git a/src/bin/dhcp4/dhcp4_srv.cc b/src/bin/dhcp4/dhcp4_srv.cc
index bfe50702f7..531b366c99 100644
--- a/src/bin/dhcp4/dhcp4_srv.cc
+++ b/src/bin/dhcp4/dhcp4_srv.cc
@@ -460,7 +460,7 @@ Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
 
 Dhcpv4Srv::~Dhcpv4Srv() {
     // Discard any cached packets or parked packets
-    dumpPackets();
+    discardPackets();
 
     try {
         stopD2();
@@ -3589,7 +3589,7 @@ int Dhcpv4Srv::getHookIndexLease4Decline() {
     return (Hooks.hook_index_lease4_decline_);
 }
 
-void Dhcpv4Srv::dumpPackets() {
+void Dhcpv4Srv::discardPackets() {
     // Clear any packets held by the callhout handle store and
     // all parked packets
     isc::dhcp::Pkt4Ptr pkt4ptr_empty;
diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h
index a1ce6c7d8a..fd8c671f6c 100644
--- a/src/bin/dhcp4/dhcp4_srv.h
+++ b/src/bin/dhcp4/dhcp4_srv.h
@@ -331,7 +331,7 @@ public:
                                       dhcp_ddns::NameChangeRequestPtr& ncr);
 
     /// @brief Discard all in-progress packets
-    void dumpPackets();
+    void discardPackets();
 
 protected:
 
diff --git a/src/bin/dhcp4/json_config_parser.cc b/src/bin/dhcp4/json_config_parser.cc
index d9139d2025..6ee88509b0 100644
--- a/src/bin/dhcp4/json_config_parser.cc
+++ b/src/bin/dhcp4/json_config_parser.cc
@@ -291,7 +291,7 @@ configureDhcp4Server(Dhcpv4Srv& server, isc::data::ConstElementPtr config_set,
     // Remove any existing timers.
     if (!check_only) {
         TimerMgr::instance()->unregisterTimers();
-        server.dumpPackets();
+        server.discardPackets();
     }
 
     // Revert any runtime option definitions configured so far and not committed.
diff --git a/src/bin/dhcp6/dhcp6_srv.cc b/src/bin/dhcp6/dhcp6_srv.cc
index 6204c7dda2..3af19693d8 100644
--- a/src/bin/dhcp6/dhcp6_srv.cc
+++ b/src/bin/dhcp6/dhcp6_srv.cc
@@ -218,7 +218,7 @@ Dhcpv6Srv::Dhcpv6Srv(uint16_t port)
 }
 
 Dhcpv6Srv::~Dhcpv6Srv() {
-    dumpPackets();
+    discardPackets();
     try {
         stopD2();
     } catch(const std::exception& ex) {
@@ -3762,11 +3762,11 @@ Dhcpv6Srv::requestedInORO(const Pkt6Ptr& query, const uint16_t code) const {
     return (false);
 }
 
-void Dhcpv6Srv::dumpPackets() {
+void Dhcpv6Srv::discardPackets() {
     // Dump all of our current packets, anything that is mid-stream
     isc::dhcp::Pkt6Ptr pkt6ptr_empty;
     isc::dhcp::getCalloutHandle(pkt6ptr_empty);
-    ServerHooks::getServerHooks().getParkingLotsPtr()->clear();
+    HooksManager::clearParkingLots();
 }
 
 };
diff --git a/src/bin/dhcp6/dhcp6_srv.h b/src/bin/dhcp6/dhcp6_srv.h
index db9ec846c7..6debce96ac 100644
--- a/src/bin/dhcp6/dhcp6_srv.h
+++ b/src/bin/dhcp6/dhcp6_srv.h
@@ -174,10 +174,10 @@ public:
                                       NameChangeSender::Result result,
                                       dhcp_ddns::NameChangeRequestPtr& ncr);
 
-    /// @brief Dumps cached and parked packets
+    /// @brief Discards cached and parked packets
     /// Clears the call_handle store and packet parking lots
     /// of all packets.  Called during reconfigure and shutdown.
-    void dumpPackets();
+    void discardPackets();
 
 protected:
 
diff --git a/src/bin/dhcp6/json_config_parser.cc b/src/bin/dhcp6/json_config_parser.cc
index 35575fd112..4d28b3781d 100644
--- a/src/bin/dhcp6/json_config_parser.cc
+++ b/src/bin/dhcp6/json_config_parser.cc
@@ -389,7 +389,7 @@ configureDhcp6Server(Dhcpv6Srv& server, isc::data::ConstElementPtr config_set,
     // Remove any existing timers.
     if (!check_only) {
         TimerMgr::instance()->unregisterTimers();
-        server.dumpPackets();
+        server.discardPackets();
     }
 
     // Revert any runtime option definitions configured so far and not committed.
diff --git a/src/lib/hooks/hooks_manager.h b/src/lib/hooks/hooks_manager.h
index b31bce34e8..903ad6aa6e 100644
--- a/src/lib/hooks/hooks_manager.h
+++ b/src/lib/hooks/hooks_manager.h
@@ -310,6 +310,11 @@ public:
         getHooksManager().referenceInternal(hook_name, parked_object);
     }
 
+    /// @brief Clears any parking packets.
+    ///
+    /// This method should be called during reconfiguration to ensure there
+    /// are no dangling pointers that could possibly prevent the library
+    /// from being unloaded.
     static void clearParkingLots() {
         getHooksManager().clearParkingLotsInternal();
     }
@@ -371,6 +376,9 @@ private:
             getParkingLotPtr(hook_name)->reference(parked_object);
     }
 
+    /// @brief Clears all pointers stored in parking lots.
+    ///
+    /// See @ref clearParkingLots for explanation.
     void clearParkingLotsInternal() {
         ServerHooks::getServerHooks().getParkingLotsPtr()->clear();
     }