A Discrete-Event Network Simulator
API
PrioQueueDiscTestFilter Class Reference

Prio Queue Disc Test Packet Filter. More...

+ Inheritance diagram for PrioQueueDiscTestFilter:
+ Collaboration diagram for PrioQueueDiscTestFilter:

Public Member Functions

 PrioQueueDiscTestFilter (bool cls)
 Constructor. More...
 
virtual ~PrioQueueDiscTestFilter ()
 
void SetReturnValue (int32_t ret)
 Set the value returned by DoClassify. More...
 
- 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...
 

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
 Classify a packet. More...
 

Private Attributes

bool m_cls
 whether this filter is able to classify a PrioQueueDiscTestItem More...
 
int32_t m_ret
 the value that DoClassify returns if m_cls is true More...
 

Additional Inherited Members

- 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...
 
- 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

Prio Queue Disc Test Packet Filter.

Definition at line 88 of file prio-queue-disc-test-suite.cc.

Constructor & Destructor Documentation

◆ PrioQueueDiscTestFilter()

PrioQueueDiscTestFilter::PrioQueueDiscTestFilter ( bool  cls)

Constructor.

Parameters
clswhether this filter is able to classify a PrioQueueDiscTestItem

Definition at line 113 of file prio-queue-disc-test-suite.cc.

◆ ~PrioQueueDiscTestFilter()

PrioQueueDiscTestFilter::~PrioQueueDiscTestFilter ( )
virtual

Definition at line 119 of file prio-queue-disc-test-suite.cc.

Member Function Documentation

◆ CheckProtocol()

bool PrioQueueDiscTestFilter::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.

Definition at line 130 of file prio-queue-disc-test-suite.cc.

References m_cls.

◆ DoClassify()

int32_t PrioQueueDiscTestFilter::DoClassify ( Ptr< QueueDiscItem item) const
privatevirtual

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.

Definition at line 136 of file prio-queue-disc-test-suite.cc.

References m_ret.

◆ SetReturnValue()

void PrioQueueDiscTestFilter::SetReturnValue ( int32_t  ret)

Set the value returned by DoClassify.

Parameters
retthe value that DoClassify returns

Definition at line 124 of file prio-queue-disc-test-suite.cc.

References m_ret.

Referenced by PrioQueueDiscTestCase::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cls

bool PrioQueueDiscTestFilter::m_cls
private

whether this filter is able to classify a PrioQueueDiscTestItem

Definition at line 109 of file prio-queue-disc-test-suite.cc.

Referenced by CheckProtocol().

◆ m_ret

int32_t PrioQueueDiscTestFilter::m_ret
private

the value that DoClassify returns if m_cls is true

Definition at line 110 of file prio-queue-disc-test-suite.cc.

Referenced by DoClassify(), and SetReturnValue().


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