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

Ipv4PacketFilter is the abstract base class for filters defined for IPv4 packets. More...

#include "ipv4-packet-filter.h"

+ Inheritance diagram for ns3::Ipv4PacketFilter:
+ Collaboration diagram for ns3::Ipv4PacketFilter:

Public Member Functions

 Ipv4PacketFilter ()
 
virtual ~Ipv4PacketFilter ()
 
- Public Member Functions inherited from ns3::PacketFilter
 PacketFilter ()
 
virtual ~PacketFilter ()
 
int32_t Classify (Ptr< QueueDiscItem > item) const
 Classify a packet. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this 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...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::PacketFilter
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

virtual bool CheckProtocol (Ptr< QueueDiscItem > item) const
 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

- Static Public Attributes inherited from ns3::PacketFilter
static const int PF_NO_MATCH = -1
 Standard value used by packet filters to indicate that no match was possible. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Ipv4PacketFilter is the abstract base class for filters defined for IPv4 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 38 of file ipv4-packet-filter.h.

Constructor & Destructor Documentation

◆ Ipv4PacketFilter()

ns3::Ipv4PacketFilter::Ipv4PacketFilter ( )

Definition at line 48 of file ipv4-packet-filter.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv4PacketFilter()

ns3::Ipv4PacketFilter::~Ipv4PacketFilter ( )
virtual

Definition at line 53 of file ipv4-packet-filter.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckProtocol()

bool ns3::Ipv4PacketFilter::CheckProtocol ( Ptr< QueueDiscItem item) const
privatevirtual

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.

Implements ns3::PacketFilter.

Reimplemented in Ipv4FqPieTestPacketFilter, Ipv4TestPacketFilter, and Ipv4FqCobaltTestPacketFilter.

Definition at line 59 of file ipv4-packet-filter.cc.

References NS_LOG_FUNCTION.

◆ DoClassify()

virtual int32_t ns3::Ipv4PacketFilter::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.

Implements ns3::PacketFilter.

Implemented in Ipv4FqPieTestPacketFilter, Ipv4TestPacketFilter, and Ipv4FqCobaltTestPacketFilter.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 39 of file ipv4-packet-filter.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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