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.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

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

Private Member Functions
virtual bool	CheckProtocol (Ptr< QueueDiscItem > item) const =0
	Checks if the filter is able to classify a kind of items.

virtual int32_t	DoClassify (Ptr< QueueDiscItem > item) const =0
	Classify a packet.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

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

item	an example item to check.

Returns: true if this filter is able to classify packets.

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

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

item	the 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

item	the packet to classify.

Returns: -1 if the item does not match the filter conditions, or the configured return value otherwise.

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

Referenced by Classify().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::PacketFilter::GetTypeId ( )

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:

src/traffic-control/model/packet-filter.h
src/traffic-control/model/packet-filter.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PacketFilter()

◆ ~PacketFilter()

Member Function Documentation

◆ CheckProtocol()

◆ Classify()

◆ DoClassify()

◆ GetTypeId()

Member Data Documentation

◆ PF_NO_MATCH