Classes | Public Member Functions

ns3::ByteTagList Class Reference
[Packet]

keep track of the tags stored in a packet. More...

#include <byte-tag-list.h>

List of all members.

Classes

class  Iterator

Public Member Functions

 ByteTagList (const ByteTagList &o)
ByteTagListoperator= (const ByteTagList &o)
TagBuffer Add (TypeId tid, uint32_t bufferSize, int32_t start, int32_t end)
void Add (const ByteTagList &o)
void RemoveAll (void)
ByteTagList::Iterator Begin (int32_t offsetStart, int32_t offsetEnd) const
void AddAtEnd (int32_t adjustment, int32_t appendOffset)
void AddAtStart (int32_t adjustment, int32_t prependOffset)

Detailed Description

keep track of the tags stored in a packet.

This class is mostly private to the Packet implementation and users should never have to access it directly.


Member Function Documentation

TagBuffer ns3::ByteTagList::Add ( TypeId  tid,
uint32_t  bufferSize,
int32_t  start,
int32_t  end 
)
Parameters:
tid the typeid of the tag added
bufferSize the size of the tag when its serialization will be completed. Typically, the return value of Tag::GetSerializedSize
start offset which uniquely identifies the first byte tagged by this tag.
end offset which uniquely identifies the last byte tagged by this tag.
Returns:
a buffer which can be used to write the tag data.
void ns3::ByteTagList::Add ( const ByteTagList o  ) 
Parameters:
o the other list of tags to aggregate.

Aggregate the two lists of tags.

void ns3::ByteTagList::AddAtEnd ( int32_t  adjustment,
int32_t  appendOffset 
)

Adjust the offsets stored internally by the adjustment delta and make sure that all offsets are smaller than appendOffset which represents the location where new bytes have been added to the byte buffer.

void ns3::ByteTagList::AddAtStart ( int32_t  adjustment,
int32_t  prependOffset 
)

Adjust the offsets stored internally by the adjustment delta and make sure that all offsets are bigger than prependOffset which represents the location where new bytes have been added to the byte buffer.

ByteTagList::Iterator ns3::ByteTagList::Begin ( int32_t  offsetStart,
int32_t  offsetEnd 
) const
Parameters:
offsetStart the offset which uniquely identifies the first data byte present in the byte buffer associated to this ByteTagList.
offsetEnd the offset which uniquely identifies the last data byte present in the byte buffer associated to this ByteTagList.
Returns:
an iterator

The returned iterator will allow you to loop through the set of tags present in this list: the boundaries of each tag as reported by their start and end offsets will be included within the input offsetStart and offsetEnd.


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