A Discrete-Event Network Simulator
API
ns3::PacketFilter Class Referenceabstract

PacketFilter is the abstract base class for filters used by queue discs to classify packets. More...

#include "packet-filter.h"

+ Inheritance diagram for ns3::PacketFilter:
+ Collaboration diagram for ns3::PacketFilter:

Public Member Functions

 PacketFilter ()
 
 ~PacketFilter () override
 
int32_t Classify (Ptr< QueueDiscItem > item) const
 Classify a packet. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Static Public Attributes

static const int PF_NO_MATCH = -1
 Standard value used by packet filters to indicate that no match was possible. More...
 

Private Member Functions

virtual bool CheckProtocol (Ptr< QueueDiscItem > item) const =0
 Checks if the filter is able to classify a kind of items. More...
 
virtual int32_t DoClassify (Ptr< QueueDiscItem > item) const =0
 Classify a packet. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

PacketFilter is the abstract base class for filters used by queue discs to classify packets.

Definition at line 34 of file packet-filter.h.

Constructor & Destructor Documentation

◆ PacketFilter()

ns3::PacketFilter::PacketFilter ( )

Definition at line 40 of file packet-filter.cc.

References NS_LOG_FUNCTION.

◆ ~PacketFilter()

ns3::PacketFilter::~PacketFilter ( )
override

Definition at line 45 of file packet-filter.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckProtocol()

virtual bool ns3::PacketFilter::CheckProtocol ( Ptr< QueueDiscItem item) const
privatepure virtual

Checks if the filter is able to classify a kind of items.

Parameters
iteman example item to check.
Returns
true if this filter is able to classify packets.

Implemented in PrioQueueDiscTestFilter, Ipv4FqPieTestPacketFilter, Ipv4TestPacketFilter, Ipv4FqCobaltTestPacketFilter, ns3::Ipv6PacketFilter, and ns3::Ipv4PacketFilter.

Referenced by Classify().

+ Here is the caller graph for this function:

◆ Classify()

int32_t ns3::PacketFilter::Classify ( Ptr< QueueDiscItem item) const

Classify a packet.

Parameters
itemthe packet to classify.
Returns
-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.

Definition at line 51 of file packet-filter.cc.

References CheckProtocol(), DoClassify(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and PF_NO_MATCH.

+ Here is the call graph for this function:

◆ DoClassify()

virtual int32_t ns3::PacketFilter::DoClassify ( Ptr< QueueDiscItem item) const
privatepure virtual

Classify a packet.

Parameters
itemthe packet to classify.
Returns
-1 if the item does not match the filter conditions, or the configured return value otherwise.

Implemented in ns3::Ipv6PacketFilter, ns3::Ipv4PacketFilter, PrioQueueDiscTestFilter, Ipv4FqPieTestPacketFilter, Ipv4TestPacketFilter, and Ipv4FqCobaltTestPacketFilter.

Referenced by Classify().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::PacketFilter::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 33 of file packet-filter.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ PF_NO_MATCH

const int ns3::PacketFilter::PF_NO_MATCH = -1
static

Standard value used by packet filters to indicate that no match was possible.

Definition at line 49 of file packet-filter.h.

Referenced by ns3::QueueDisc::Classify(), Classify(), ns3::FqCobaltQueueDisc::DoEnqueue(), ns3::FqCoDelQueueDisc::DoEnqueue(), ns3::FqPieQueueDisc::DoEnqueue(), and ns3::PrioQueueDisc::DoEnqueue().


The documentation for this class was generated from the following files: