network, internet: Clarify QueueDiscItem::Mark if item already marked

This commit is contained in:
Tom Henderson
2020-06-29 16:23:14 -07:00
parent f15a942835
commit 8a60bdff13
3 changed files with 7 additions and 5 deletions

View File

@@ -77,8 +77,9 @@ public:
virtual bool GetUint8Value (Uint8Values field, uint8_t &value) const;
/**
* \brief Marks the packet by setting ECN_CE bits if the packet has ECN_ECT0 or ECN_ECT1 bits set
* \return true if the packet gets marked, false otherwise
* \brief Marks the packet by setting ECN_CE bits if the packet has
* ECN_ECT0 or ECN_ECT1 set. If ECN_CE is already set, returns true.
* \return true if the method results in a marked packet, false otherwise
*/
virtual bool Mark (void);

View File

@@ -77,8 +77,9 @@ public:
virtual bool GetUint8Value (Uint8Values field, uint8_t &value) const;
/**
* \brief Marks the packet by setting ECN_CE bits if the packet has ECN_ECT0 or ECN_ECT1 bits set
* \return true if the packet gets marked, false otherwise
* \brief Marks the packet by setting ECN_CE bits if the packet has
* ECN_ECT0 or ECN_ECT1 set. If ECN_CE is already set, returns true.
* \return true if the method results in a marked packet, false otherwise
*/
virtual bool Mark (void);

View File

@@ -211,7 +211,7 @@ public:
/**
* \brief Marks the packet as a substitute for dropping it, such as for Explicit Congestion Notification
*
* \return true if the packet gets marked, false otherwise
* \return true if the packet is marked by this method or is already marked, false otherwise
*/
virtual bool Mark (void) = 0;