A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::PacketMetadata::Item Struct Reference

structure describing a packet metadata item More...

#include "packet-metadata.h"

+ Collaboration diagram for ns3::PacketMetadata::Item:

Public Types

enum  ItemType { PAYLOAD , HEADER , TRAILER }
 Type of data in the packet. More...
 

Public Attributes

Buffer::Iterator current
 an iterator which can be fed to Deserialize.
 
uint32_t currentSize
 size of item.
 
uint32_t currentTrimmedFromEnd
 how many bytes were trimmed from the end of a fragment.
 
uint32_t currentTrimmedFromStart
 how many bytes were trimmed from the start of a fragment.
 
bool isFragment
 true: this is a fragmented header, trailer, or, payload.
 
TypeId tid
 TypeId of Header or Trailer.
 
ItemType type
 metadata type
 

Detailed Description

structure describing a packet metadata item

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

Member Enumeration Documentation

◆ ItemType

Type of data in the packet.

Enumerator
PAYLOAD 

Payload.

HEADER 

Header.

TRAILER 

Trailer.

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

Member Data Documentation

◆ current

Buffer::Iterator ns3::PacketMetadata::Item::current

an iterator which can be fed to Deserialize.

Valid only if isFragment and isPayload are false.

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

Referenced by PacketMetadataTest::CheckHistory(), ns3::PacketMetadata::ItemIterator::Next(), and ns3::Packet::Print().

◆ currentSize

uint32_t ns3::PacketMetadata::Item::currentSize

size of item.

If fragment, size of fragment. Otherwise, size of original item.

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

Referenced by PacketMetadataTest::CheckHistory(), ns3::PacketMetadata::ItemIterator::Next(), and ns3::Packet::Print().

◆ currentTrimmedFromEnd

uint32_t ns3::PacketMetadata::Item::currentTrimmedFromEnd

how many bytes were trimmed from the end of a fragment.

if isFragment is true, this field is zero.

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

Referenced by ns3::PacketMetadata::ItemIterator::Next().

◆ currentTrimmedFromStart

uint32_t ns3::PacketMetadata::Item::currentTrimmedFromStart

how many bytes were trimmed from the start of a fragment.

if isFragment is true, this field is zero.

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

Referenced by ns3::PacketMetadata::ItemIterator::Next(), and ns3::Packet::Print().

◆ isFragment

bool ns3::PacketMetadata::Item::isFragment

true: this is a fragmented header, trailer, or, payload.

false: this is a whole header, trailer, or, payload.

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

Referenced by PacketMetadataTest::CheckHistory(), ns3::PacketMetadata::ItemIterator::Next(), and ns3::Packet::Print().

◆ tid

TypeId ns3::PacketMetadata::Item::tid

TypeId of Header or Trailer.

Valid only if type is header or trailer.

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

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

◆ type

ItemType ns3::PacketMetadata::Item::type

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