A Discrete-Event Network Simulator
API
ns3::QueueItem Class Reference

Base class to represent items of packet Queues. More...

#include "queue-item.h"

+ Inheritance diagram for ns3::QueueItem:
+ Collaboration diagram for ns3::QueueItem:

Public Types

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

Public Member Functions

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

Private Member Functions

 QueueItem ()
 Default constructor. More...
 
 QueueItem (const QueueItem &)
 Copy constructor. More...
 
QueueItemoperator= (const QueueItem &)
 Assignment operator. More...
 

Private Attributes

Ptr< Packetm_packet
 The packet contained in the queue item. More...
 

Detailed Description

Base class to represent items of packet Queues.

An item stored in an ns-3 packet Queue contains a packet and possibly other information. An item of the base class only contains a packet. Subclasses can be derived from this base class to allow items to contain additional information.

Definition at line 46 of file queue-item.h.

Member Typedef Documentation

typedef void(* ns3::QueueItem::TracedCallback) (Ptr< const QueueItem > item)

TracedCallback signature for Ptr<QueueItem>

Parameters
[in]itemThe queue item.

Definition at line 101 of file queue-item.h.

Member Enumeration Documentation

1-byte fields of the packet whose value can be retrieved, if present

Enumerator
IP_DSFIELD 

Definition at line 76 of file queue-item.h.

Constructor & Destructor Documentation

ns3::QueueItem::QueueItem ( Ptr< Packet p)

Create a queue item containing a packet.

Parameters
pthe packet included in the created item.

Definition at line 29 of file queue-item.cc.

References m_packet, and NS_LOG_FUNCTION.

ns3::QueueItem::~QueueItem ( )
virtual

Definition at line 35 of file queue-item.cc.

References m_packet, and NS_LOG_FUNCTION.

ns3::QueueItem::QueueItem ( )
private

Default constructor.

Defined and unimplemented to avoid misuse

ns3::QueueItem::QueueItem ( const QueueItem )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

uint32_t ns3::QueueItem::GetSize ( void  ) const
virtual

Use this method (instead of GetPacket ()->GetSize ()) to get the packet size.

Subclasses may keep header and payload separate to allow manipulating the header, so using this method ensures that the correct packet size is returned.

Returns
the size of the packet included in this item.

Reimplemented in ns3::QKDQueueDiscItem, ns3::ArpQueueDiscItem, ns3::Ipv4QueueDiscItem, and ns3::Ipv6QueueDiscItem.

Definition at line 49 of file queue-item.cc.

References ns3::Packet::GetSize(), m_packet, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by QueueDiscTracesTestCase::DoRun(), TestCounter::PacketDad(), TestCounter::PacketDbe(), TestCounter::PacketDequeued(), and TestCounter::PacketEnqueued().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::QueueItem::GetUint8Value ( QueueItem::Uint8Values  field,
uint8_t &  value 
) const
virtual

Retrieve the value of a given field from the packet, if present.

Parameters
fieldthe field whose value has to be retrieved
valuethe output parameter to store the retrieved value
Returns
true if the requested field is present in the packet, false otherwise.

Reimplemented in ns3::Ipv4QueueDiscItem, and ns3::Ipv6QueueDiscItem.

Definition at line 57 of file queue-item.cc.

References NS_LOG_FUNCTION.

Referenced by WifiAcMappingTest::PacketEnqueuedInQueueDisc().

+ Here is the caller graph for this function:

QueueItem& ns3::QueueItem::operator= ( const QueueItem )
private

Assignment operator.

Defined and unimplemented to avoid misuse

Returns
void ns3::QueueItem::Print ( std::ostream &  os) const
virtual

Print the item contents.

Parameters
osoutput stream in which the data should be printed.

Reimplemented in ns3::QueueDiscItem, ns3::QKDQueueDiscItem, ns3::ArpQueueDiscItem, ns3::Ipv4QueueDiscItem, and ns3::Ipv6QueueDiscItem.

Definition at line 64 of file queue-item.cc.

References GetPacket().

Referenced by ns3::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

Ptr<Packet> ns3::QueueItem::m_packet
private

The packet contained in the queue item.

Definition at line 127 of file queue-item.h.

Referenced by GetPacket(), GetSize(), QueueItem(), and ~QueueItem().


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