A Discrete-Event Network Simulator
API
PieQueueDiscTestItem Class Reference

Pie Queue Disc Test Item. More...

+ Inheritance diagram for PieQueueDiscTestItem:
+ Collaboration diagram for PieQueueDiscTestItem:

Public Member Functions

 PieQueueDiscTestItem ()=delete
 
 PieQueueDiscTestItem (const PieQueueDiscTestItem &)=delete
 
 PieQueueDiscTestItem (Ptr< Packet > p, const Address &addr, bool ecnCapable)
 Constructor. More...
 
virtual ~PieQueueDiscTestItem ()
 
virtual void AddHeader (void)
 Add the header to the packet. More...
 
virtual bool Mark (void)
 Marks the packet as a substitute for dropping it, such as for Explicit Congestion Notification. More...
 
PieQueueDiscTestItemoperator= (const PieQueueDiscTestItem &)=delete
 
- Public Member Functions inherited from ns3::QueueDiscItem
 QueueDiscItem ()=delete
 
 QueueDiscItem (const QueueDiscItem &)=delete
 
 QueueDiscItem (Ptr< Packet > p, const Address &addr, uint16_t protocol)
 Create a queue disc item. More...
 
virtual ~QueueDiscItem ()
 
virtual void AddHeader (void)=0
 Add the header to the packet. More...
 
Address GetAddress (void) const
 Get the MAC address included in this item. More...
 
uint16_t GetProtocol (void) const
 Get the L3 protocol included in this item. More...
 
Time GetTimeStamp (void) const
 Get the timestamp included in this item. More...
 
uint8_t GetTxQueueIndex (void) const
 Get the transmission queue index included in this item. More...
 
virtual uint32_t Hash (uint32_t perturbation=0) const
 Computes the hash of various fields of the packet header. More...
 
virtual bool Mark (void)=0
 Marks the packet as a substitute for dropping it, such as for Explicit Congestion Notification. More...
 
QueueDiscItemoperator= (const QueueDiscItem &)=delete
 
virtual void Print (std::ostream &os) const
 Print the item contents. More...
 
void SetTimeStamp (Time t)
 Set the timestamp included in this item. More...
 
void SetTxQueueIndex (uint8_t txq)
 Set the transmission queue index to store in this item. More...
 
- Public Member Functions inherited from ns3::QueueItem
 QueueItem ()=delete
 
 QueueItem (const QueueItem &)=delete
 
 QueueItem (Ptr< Packet > p)
 Create a queue item containing a packet. More...
 
virtual ~QueueItem ()
 
Ptr< PacketGetPacket (void) const
 
virtual uint32_t GetSize (void) const
 Use this method (instead of GetPacket ()->GetSize ()) to get the packet size. More...
 
virtual bool GetUint8Value (Uint8Values field, uint8_t &value) const
 Retrieve the value of a given field from the packet, if present. More...
 
QueueItemoperator= (const QueueItem &)=delete
 
virtual void Print (std::ostream &os) const
 Print the item contents. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< QueueItem >
 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 Attributes

double m_accuProbError = 0.0
 Error in accumulated drop probability. More...
 
bool m_checkAccuProb = false
 Enable/Disable accumulated drop probability checks. More...
 
bool m_checkMaxAccuProb = false
 Enable/Disable Maximum accumulated drop probability checks. More...
 
bool m_checkProb = false
 Enable/Disable drop probability checks. More...
 
bool m_constAccuProb = false
 Enable/Disable fixed accumulated drop probability. More...
 
bool m_ecnCapable = false
 Enable/Disable ECN capability. More...
 
uint32_t m_expectedDrops = 0
 Number of expected unforced drops. More...
 
double m_maxDropProb = 0.0
 Maximum value of drop probability. More...
 
double m_maxDropProbDiff = 0.0
 Maximum difference between two consecutive drop probability values. More...
 
double m_prevAccuProb = 0.0
 Previous accumulated drop probability. More...
 
double m_prevDropProb = 0.0
 Previous drop probability. More...
 
double m_setAccuProb = 0.0
 Value to be set for accumulated drop probability. More...
 

Private Attributes

bool m_ecnCapablePacket
 ECN capable packet? More...
 

Additional Inherited Members

- Public Types inherited from ns3::QueueItem
typedef void(* TracedCallback) (Ptr< const QueueItem > item)
 TracedCallback signature for Ptr<QueueItem> More...
 
enum  Uint8Values { IP_DSFIELD }
 1-byte fields of the packet whose value can be retrieved, if present More...
 

Detailed Description

Pie Queue Disc Test Item.

Definition at line 41 of file pie-queue-disc-test-suite.cc.

Constructor & Destructor Documentation

◆ PieQueueDiscTestItem() [1/3]

PieQueueDiscTestItem::PieQueueDiscTestItem ( Ptr< Packet p,
const Address addr,
bool  ecnCapable 
)

Constructor.

Parameters
pthe packet
addrthe address
ecnCapableECN capable flag

Definition at line 84 of file pie-queue-disc-test-suite.cc.

◆ ~PieQueueDiscTestItem()

PieQueueDiscTestItem::~PieQueueDiscTestItem ( )
virtual

Definition at line 89 of file pie-queue-disc-test-suite.cc.

◆ PieQueueDiscTestItem() [2/3]

PieQueueDiscTestItem::PieQueueDiscTestItem ( )
delete

◆ PieQueueDiscTestItem() [3/3]

PieQueueDiscTestItem::PieQueueDiscTestItem ( const PieQueueDiscTestItem )
delete

Member Function Documentation

◆ AddHeader()

void PieQueueDiscTestItem::AddHeader ( void  )
virtual

Add the header to the packet.

Subclasses may keep header and payload separate to allow manipulating the header, so this method allows to add the header to the packet before sending the packet to the device.

Implements ns3::QueueDiscItem.

Definition at line 94 of file pie-queue-disc-test-suite.cc.

◆ Mark()

bool PieQueueDiscTestItem::Mark ( void  )
virtual

Marks the packet as a substitute for dropping it, such as for Explicit Congestion Notification.

Returns
true if the packet is marked by this method or is already marked, false otherwise

Implements ns3::QueueDiscItem.

Definition at line 99 of file pie-queue-disc-test-suite.cc.

References m_ecnCapablePacket.

◆ operator=()

PieQueueDiscTestItem & PieQueueDiscTestItem::operator= ( const PieQueueDiscTestItem )
delete

Member Data Documentation

◆ m_accuProbError

double PieQueueDiscTestItem::m_accuProbError = 0.0

Error in accumulated drop probability.

Definition at line 75 of file pie-queue-disc-test-suite.cc.

◆ m_checkAccuProb

bool PieQueueDiscTestItem::m_checkAccuProb = false

Enable/Disable accumulated drop probability checks.

Definition at line 72 of file pie-queue-disc-test-suite.cc.

◆ m_checkMaxAccuProb

bool PieQueueDiscTestItem::m_checkMaxAccuProb = false

Enable/Disable Maximum accumulated drop probability checks.

Definition at line 74 of file pie-queue-disc-test-suite.cc.

◆ m_checkProb

bool PieQueueDiscTestItem::m_checkProb = false

Enable/Disable drop probability checks.

Definition at line 65 of file pie-queue-disc-test-suite.cc.

◆ m_constAccuProb

bool PieQueueDiscTestItem::m_constAccuProb = false

Enable/Disable fixed accumulated drop probability.

Definition at line 73 of file pie-queue-disc-test-suite.cc.

◆ m_ecnCapable

bool PieQueueDiscTestItem::m_ecnCapable = false

Enable/Disable ECN capability.

Definition at line 69 of file pie-queue-disc-test-suite.cc.

◆ m_ecnCapablePacket

bool PieQueueDiscTestItem::m_ecnCapablePacket
private

ECN capable packet?

Definition at line 81 of file pie-queue-disc-test-suite.cc.

Referenced by Mark().

◆ m_expectedDrops

uint32_t PieQueueDiscTestItem::m_expectedDrops = 0

Number of expected unforced drops.

Definition at line 78 of file pie-queue-disc-test-suite.cc.

◆ m_maxDropProb

double PieQueueDiscTestItem::m_maxDropProb = 0.0

Maximum value of drop probability.

Definition at line 68 of file pie-queue-disc-test-suite.cc.

◆ m_maxDropProbDiff

double PieQueueDiscTestItem::m_maxDropProbDiff = 0.0

Maximum difference between two consecutive drop probability values.

Definition at line 63 of file pie-queue-disc-test-suite.cc.

◆ m_prevAccuProb

double PieQueueDiscTestItem::m_prevAccuProb = 0.0

Previous accumulated drop probability.

Definition at line 76 of file pie-queue-disc-test-suite.cc.

◆ m_prevDropProb

double PieQueueDiscTestItem::m_prevDropProb = 0.0

Previous drop probability.

Definition at line 64 of file pie-queue-disc-test-suite.cc.

◆ m_setAccuProb

double PieQueueDiscTestItem::m_setAccuProb = 0.0

Value to be set for accumulated drop probability.

Definition at line 77 of file pie-queue-disc-test-suite.cc.


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