A Discrete-Event Network Simulator
CodelQueueDiscTestItem Class Reference

Codel Queue Disc Test Item. More...

+ Inheritance diagram for CodelQueueDiscTestItem:
+ Collaboration diagram for CodelQueueDiscTestItem:

Public Member Functions

 CodelQueueDiscTestItem (const CodelQueueDiscTestItem &)=delete
 CodelQueueDiscTestItem (Ptr< Packet > p, const Address &addr, bool ecnCapable)
 Constructor. More...
virtual ~CodelQueueDiscTestItem ()
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...
CodelQueueDiscTestItemoperator= (const CodelQueueDiscTestItem &)=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 ()
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...
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
- Public Member Functions inherited from ns3::SimpleRefCount< QueueItem >
 SimpleRefCount ()
 Default constructor. More...
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
void Ref (void) const
 Increment the reference count. More...
void Unref (void) const
 Decrement the reference count. More...

Private Member Functions

 CodelQueueDiscTestItem ()

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

Codel Queue Disc Test Item.

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

Constructor & Destructor Documentation

◆ CodelQueueDiscTestItem() [1/3]

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


ecnCapableECN capable

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

◆ ~CodelQueueDiscTestItem()

CodelQueueDiscTestItem::~CodelQueueDiscTestItem ( )

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

◆ CodelQueueDiscTestItem() [2/3]

CodelQueueDiscTestItem::CodelQueueDiscTestItem ( const CodelQueueDiscTestItem )

◆ CodelQueueDiscTestItem() [3/3]

CodelQueueDiscTestItem::CodelQueueDiscTestItem ( )

Member Function Documentation

◆ AddHeader()

void CodelQueueDiscTestItem::AddHeader ( void  )

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 99 of file codel-queue-disc-test-suite.cc.

◆ Mark()

bool CodelQueueDiscTestItem::Mark ( void  )

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

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

Implements ns3::QueueDiscItem.

Definition at line 104 of file codel-queue-disc-test-suite.cc.

References m_ecnCapablePacket.

◆ operator=()

CodelQueueDiscTestItem& CodelQueueDiscTestItem::operator= ( const CodelQueueDiscTestItem )

Member Data Documentation

◆ m_ecnCapablePacket

bool CodelQueueDiscTestItem::m_ecnCapablePacket

ECN capable packet?

Definition at line 85 of file codel-queue-disc-test-suite.cc.

Referenced by Mark().

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