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< Packet >	GetPacket (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...

SimpleRefCount &	operator= (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...

QueueItem &	operator= (const QueueItem &)
	Assignment operator. More...

Private Attributes
Ptr< Packet >	m_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] item The queue item.

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

Constructor & Destructor Documentation

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

Create a queue item containing a packet.

Parameters

p	the 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

Ptr< Packet > ns3::QueueItem::GetPacket ( void ) const

Returns: the packet included in this item.

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

References m_packet, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4QueueDiscItem::AddHeader(), ns3::Ipv6QueueDiscItem::AddHeader(), ns3::FqCoDelIpv4PacketFilter::DoClassify(), UdpSocketImplTest::GetPriority(), ns3::Ipv4QueueDiscItem::GetSize(), ns3::Ipv6QueueDiscItem::GetSize(), ns3::Ipv4QueueDiscItem::Print(), ns3::Ipv6QueueDiscItem::Print(), Print(), ns3::QueueDiscItem::Print(), and UdpSocketImplTest::SentPkt().

Here is the caller graph for this function:

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.