Commit 21dad40c authored by Thomas Markwalder's avatar Thomas Markwalder

[#278,!162] Addressed review comments

parent 414b2d8a
......@@ -78,6 +78,7 @@
* - @subpage dhcpv6ConfigBackend
* - @subpage dhcpv6SignalBasedReconfiguration
* - @subpage dhcpv6Other
* - @subpage dhcpv4o6Dhcp6
* - @subpage congestionHandling
* - @subpage d2
* - @subpage d2ProcessDerivation
......
......@@ -41,8 +41,11 @@ enum class QueueEnd {
/// This class serves as the abstract interface for packet queue
/// implementations which may be used by @c IfaceMgr to store
/// inbound packets until they are a dequeued for processing.
/// @note Derivations of this class MUST BE thread-safe.
///
/// @tparam PacktTypePtr Type of packet the queue contains.
/// This expected to be either isc::dhcp::Pkt4Ptr or isc::dhcp::Pkt6Ptr
///
/// @note Derivations of this class MUST BE thread-safe.
template<typename PacketTypePtr>
class PacketQueue {
public:
......
......@@ -18,7 +18,10 @@ namespace isc {
namespace dhcp {
/// @brief Provides an abstract ring-buffer implementation of the PacketQueue interface.
/// @brief Provides a ring-buffer implementation of the PacketQueue interface.
///
/// @tparam PacktTypePtr Type of packet the queue contains.
/// This expected to be either isc::dhcp::Pkt4Ptr or isc::dhcp::Pkt6Ptr
template<typename PacketTypePtr>
class PacketQueueRing : public PacketQueue<PacketTypePtr> {
public:
......@@ -66,11 +69,11 @@ public:
/// @brief Determines if a packet should be discarded.
///
/// This function is called in @c enqueuePackets for each packet
/// in its packet list. It provides an opportunity to examine the
/// in its packet list. It provides an opportunity to examine the
/// packet and its source and decide whether it should be dropped
/// or added to the queue. Derivations are expected to provide
/// implementations based on their own requirements. Bear in mind
/// that the packet has NOT been unpacked at this point. The default
/// or added to the queue. Derivations are expected to provide
/// implementations based on their own requirements. Bear in mind
/// that the packet has NOT been unpacked at this point. The default
/// implementation simply returns false (i.e. keep the packet).
///
/// @return true if the packet should be dropped, false if it should be
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment