traffic-control: doxygen fixes

This commit is contained in:
Tommaso Pecorella
2016-04-07 00:33:40 +02:00
parent 23d3d0c46d
commit b5245c59ae
2 changed files with 22 additions and 2 deletions

View File

@@ -257,6 +257,9 @@ public:
std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
/**
* Container type for Class IDs
*/
typedef std::vector<uint16_t> ClassIdList;
/**
@@ -351,6 +354,9 @@ public:
std::string n14 = "", const AttributeValue &v14 = EmptyAttributeValue (),
std::string n15 = "", const AttributeValue &v15 = EmptyAttributeValue ());
/**
* Container type for Handlers
*/
typedef std::vector<uint16_t> HandleList;
/**

View File

@@ -42,9 +42,16 @@ public:
PacketFilter ();
virtual ~PacketFilter ();
/**
* Standard value used by packet filters to indicate that no match was possible.
*/
static const int PF_NO_MATCH = -1;
/**
* \brief Classify a packet.
*
* \param item the packet to classify.
*
* \return -1 if this filter is not able to classify packets of the same protocol
* as item or the item does not match the filter conditions, the configured return
* value otherwise.
@@ -53,12 +60,19 @@ public:
private:
/**
* \return true if this filter is able to classify packets of the same protocol as item.
* \brief Checks if the filter is able to classify a kind of items.
*
* \param item an example item to check.
* \return true if this filter is able to classify packets.
*/
virtual bool CheckProtocol (Ptr<QueueDiscItem> item) const = 0;
/**
* \return -1 if the item does not match the filter conditions, the configured
* \brief Classify a packet.
*
* \param item the packet to classify.
*
* \return -1 if the item does not match the filter conditions, or the configured
* return value otherwise.
*/
virtual int32_t DoClassify (Ptr<QueueDiscItem> item) const = 0;