From: Thomas Markwalder <tmark@isc.org>
Date: Thu, 8 Nov 2018 11:43:32 +0000 (-0500)
Subject: [#42, !103] Additional review fixes
X-Git-Tag: Kea-1.5.0-beta1~12^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d0b75afb098bf8f8703d766d6001f683ad096712;p=thirdparty%2Fkea.git

[#42, !103] Additional review fixes

    Minor commentary changes.
---

diff --git a/src/lib/dhcp/iface_mgr.cc b/src/lib/dhcp/iface_mgr.cc
index a349e1d01b..044fbb6081 100644
--- a/src/lib/dhcp/iface_mgr.cc
+++ b/src/lib/dhcp/iface_mgr.cc
@@ -300,12 +300,6 @@ void IfaceMgr::stopDHCPReceiver() {
     getPacketQueue4()->clear();
 }
 
-
-void
-IfaceMgr::closeSockets(const uint16_t) {
-    isc_throw(NotImplemented, "closeSockets(family) is obsolete");
-}
-
 IfaceMgr::~IfaceMgr() {
     // control_buf_ is deleted automatically (scoped_ptr)
     control_buf_len_ = 0;
diff --git a/src/lib/dhcp/iface_mgr.h b/src/lib/dhcp/iface_mgr.h
index 9a3ffdd568..979e2667a7 100644
--- a/src/lib/dhcp/iface_mgr.h
+++ b/src/lib/dhcp/iface_mgr.h
@@ -919,12 +919,6 @@ public:
     /// Is used in destructor, but also from Dhcpv4Srv and Dhcpv6Srv classes.
     void closeSockets();
 
-    /// @brief Closes all IPv4 or IPv6 sockets.
-    ///
-    /// Obsolete!
-    /// @throw NotImplemented
-    void closeSockets(const uint16_t family);
-
     /// @brief Returns number of detected interfaces.
     ///
     /// @return number of detected interfaces
diff --git a/src/lib/dhcp/packet_queue.h b/src/lib/dhcp/packet_queue.h
index aa427aa0c1..32e2c4a95c 100644
--- a/src/lib/dhcp/packet_queue.h
+++ b/src/lib/dhcp/packet_queue.h
@@ -47,7 +47,7 @@ public:
 
     /// @brief Constructor
     ///
-    /// @param queue_type name of this queue's implementation type.
+    /// @param queue_type logical name of the queue implementation
     /// Typically this is assigned by the factory that creates the
     /// queue.  It is the logical name used to register queue
     /// implementations.
@@ -233,7 +233,7 @@ public:
 
     /// @brief Constructor
     ///
-    /// @param queue_type logical name of the queue type
+    /// @param queue_type logical name of the queue implementation
     /// @param queue_capacity maximum number of packets the queue can hold
     PacketQueueRing(const std::string& queue_type, size_t capacity)
         : PacketQueue<PacketTypePtr>(queue_type) {
@@ -365,6 +365,7 @@ class PacketQueueRing4 : public PacketQueueRing<Pkt4Ptr> {
 public:
     /// @brief Constructor
     ///
+    /// @param queue_type logical name of the queue implementation
     /// @param capacity maximum number of packets the queue can hold
     PacketQueueRing4(const std::string& queue_type, size_t capacity)
         : PacketQueueRing(queue_type, capacity) {
@@ -384,6 +385,7 @@ class PacketQueueRing6 : public PacketQueueRing<Pkt6Ptr> {
 public:
     /// @brief Constructor
     ///
+    /// @param queue_type logical name of the queue implementation
     /// @param capacity maximum number of packets the queue can hold
     PacketQueueRing6(const std::string& queue_type, size_t capacity)
         : PacketQueueRing(queue_type, capacity) {
diff --git a/src/lib/dhcp/packet_queue_mgr4.cc b/src/lib/dhcp/packet_queue_mgr4.cc
index a982195b8e..079c067de1 100644
--- a/src/lib/dhcp/packet_queue_mgr4.cc
+++ b/src/lib/dhcp/packet_queue_mgr4.cc
@@ -13,6 +13,9 @@ namespace isc {
 namespace dhcp {
 
 PacketQueueMgr4::PacketQueueMgr4() {
+    // @todo Please forgive magic strings and constants.  The default values,
+    // mechanisms will soon be reworked.
+
     // Register default queue factory
     registerPacketQueueFactory("kea-ring4", [](data::ConstElementPtr parameters)
                                           -> PacketQueue4Ptr {
@@ -28,7 +31,6 @@ PacketQueueMgr4::PacketQueueMgr4() {
             return (queue);
         });
 
-    /// @todo default comes from ? 
     data::ElementPtr parameters = data::Element::createMap();
     parameters->set("queue-type", data::Element::create("kea-ring4"));
     parameters->set("capacity", data::Element::create(static_cast<long int>(500)));
diff --git a/src/lib/dhcp/packet_queue_mgr6.cc b/src/lib/dhcp/packet_queue_mgr6.cc
index 77767ff162..b6c8ad9212 100644
--- a/src/lib/dhcp/packet_queue_mgr6.cc
+++ b/src/lib/dhcp/packet_queue_mgr6.cc
@@ -13,6 +13,9 @@ namespace isc {
 namespace dhcp {
 
 PacketQueueMgr6::PacketQueueMgr6() {
+    // @todo Please forgive magic strings and constants.  The default values,
+    // mechanisms will soon be reworked.
+
     // Register default queue factory
     registerPacketQueueFactory("kea-ring6", [](data::ConstElementPtr parameters)
                                           -> PacketQueue6Ptr {
@@ -28,7 +31,6 @@ PacketQueueMgr6::PacketQueueMgr6() {
             return (queue);
         });
 
-    // @todo default comes from ?
     data::ElementPtr parameters = data::Element::createMap();
     parameters->set("queue-type", data::Element::create("kea-ring6"));
     parameters->set("capacity", data::Element::create(static_cast<long int>(500)));