ns3::PacketMetadata::ItemIterator Class Reference

Iterator class for metadata items. More...

#include <packet-metadata.h>

Collaboration diagram for ns3::PacketMetadata::ItemIterator:

Public Member Functions
	ItemIterator (const PacketMetadata *metadata, Buffer buffer)
	Constructor. More...
bool	HasNext (void) const
	Checks if there is another metadata item. More...
Item	Next (void)
	Retrieve the next metadata item. More...

Private Attributes
Buffer	m_buffer
	buffer the metadata refers to More...
uint16_t	m_current
	current position More...
bool	m_hasReadTail
	true if the metadata tail has been read More...
const PacketMetadata *	m_metadata
	pointer to the metadata More...
uint32_t	m_offset
	offset More...

Detailed Description

Iterator class for metadata items.

Definition at line 127 of file packet-metadata.h.

Constructor & Destructor Documentation

ns3::PacketMetadata::ItemIterator::ItemIterator	(	const PacketMetadata *	metadata,
		Buffer	buffer
	)

Constructor.

Parameters

metadata	a pointer to the metadata
buffer	the buffer the metadata refers to

Definition at line 1052 of file packet-metadata.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

bool ns3::PacketMetadata::ItemIterator::HasNext

(

void

)

const

Checks if there is another metadata item.

Returns

true if there is another item

Definition at line 1062 of file packet-metadata.cc.

References NS_LOG_FUNCTION.

Referenced by PacketMetadataTest::CheckHistory(), ns3::PyViz::FilterPacket(), and ns3::Packet::Print().

Here is the caller graph for this function:

PacketMetadata::Item ns3::PacketMetadata::ItemIterator::Next

(

void

)

Retrieve the next metadata item.

Returns

the next metadata item

Definition at line 1076 of file packet-metadata.cc.

References ns3::Buffer::Begin(), ns3::PacketMetadata::Item::current, ns3::PacketMetadata::Item::currentSize, ns3::PacketMetadata::Item::currentTrimedFromEnd, ns3::PacketMetadata::Item::currentTrimedFromStart, ns3::Buffer::End(), ns3::PacketMetadata::ExtraItem::fragmentEnd, ns3::PacketMetadata::ExtraItem::fragmentStart, ns3::Buffer::GetSize(), ns3::Trailer::GetTypeId(), ns3::Header::GetTypeId(), ns3::PacketMetadata::Item::HEADER, ns3::TypeId::IsChildOf(), ns3::PacketMetadata::Item::isFragment, ns3::PacketMetadata::SmallItem::next, NS_ASSERT, NS_LOG_FUNCTION, ns3::PacketMetadata::Item::PAYLOAD, ns3::Buffer::RemoveAtEnd(), ns3::Buffer::RemoveAtStart(), ns3::TypeId::SetUid(), ns3::PacketMetadata::SmallItem::size, ns3::PacketMetadata::Item::tid, ns3::PacketMetadata::Item::TRAILER, ns3::PacketMetadata::Item::type, and ns3::PacketMetadata::SmallItem::typeUid.

Referenced by PacketMetadataTest::CheckHistory(), ns3::PyViz::FilterPacket(), and ns3::Packet::Print().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Buffer ns3::PacketMetadata::ItemIterator::m_buffer

private

buffer the metadata refers to

Definition at line 148 of file packet-metadata.h.

uint16_t ns3::PacketMetadata::ItemIterator::m_current

private

current position

Definition at line 149 of file packet-metadata.h.

bool ns3::PacketMetadata::ItemIterator::m_hasReadTail

private

true if the metadata tail has been read

Definition at line 151 of file packet-metadata.h.

const PacketMetadata* ns3::PacketMetadata::ItemIterator::m_metadata

private

pointer to the metadata

Definition at line 147 of file packet-metadata.h.

uint32_t ns3::PacketMetadata::ItemIterator::m_offset

private

offset

Definition at line 150 of file packet-metadata.h.

---

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

• src/network/model/packet-metadata.h
• src/network/model/packet-metadata.cc