The packet header for the Radio Link Control (RLC) protocol packets. More...

#include <lte-rlc-header.h>

Inheritance diagram for ns3::LteRlcHeader:

Collaboration diagram for ns3::LteRlcHeader:

Public Types
enum	ExtensionBit_t { DATA_FIELD_FOLLOWS = 0, E_LI_FIELDS_FOLLOWS = 1 }
enum	FramingInfoFirstByte_t { FIRST_BYTE = 0x00, NO_FIRST_BYTE = 0x02 }
enum	FramingInfoLastByte_t { LAST_BYTE = 0x00, NO_LAST_BYTE = 0x01 }

Public Member Functions
	LteRlcHeader ()
	Constructor.
	~LteRlcHeader ()
virtual uint32_t	Deserialize (Buffer::Iterator start)
uint8_t	GetFramingInfo () const
virtual TypeId	GetInstanceTypeId (void) const
SequenceNumber10	GetSequenceNumber () const
virtual uint32_t	GetSerializedSize (void) const
uint8_t	PopExtensionBit (void)
uint16_t	PopLengthIndicator (void)
virtual void	Print (std::ostream &os) const
void	PushExtensionBit (uint8_t extensionBit)
void	PushLengthIndicator (uint16_t lengthIndicator)
virtual void	Serialize (Buffer::Iterator start) const
void	SetFramingInfo (uint8_t framingInfo)
void	SetSequenceNumber (SequenceNumber10 sequenceNumber)
Public Member Functions inherited from ns3::Header
virtual	~Header ()

Static Public Member Functions
static TypeId	GetTypeId (void)

Private Attributes
std::list< uint8_t >	m_extensionBits
uint8_t	m_framingInfo
uint16_t	m_headerLength
std::list< uint16_t >	m_lengthIndicators
SequenceNumber10	m_sequenceNumber

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

The packet header for the Radio Link Control (RLC) protocol packets.

This class has fields corresponding to those in an RLC header as well as methods for serialization to and deserialization from a byte buffer. It follows 3GPP TS 36.322 Radio Link Control (RLC) protocol specification.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 39 of file lte-rlc-header.h.

Member Enumeration Documentation

enum ns3::LteRlcHeader::ExtensionBit_t

Enumerator:

DATA_FIELD_FOLLOWS
E_LI_FIELDS_FOLLOWS

Definition at line 63 of file lte-rlc-header.h.

enum ns3::LteRlcHeader::FramingInfoFirstByte_t

Enumerator:

FIRST_BYTE
NO_FIRST_BYTE

Definition at line 68 of file lte-rlc-header.h.

enum ns3::LteRlcHeader::FramingInfoLastByte_t

Enumerator:

LAST_BYTE
NO_LAST_BYTE

Definition at line 73 of file lte-rlc-header.h.

Constructor & Destructor Documentation

ns3::LteRlcHeader::LteRlcHeader ( )

Constructor.

Creates a null header

Definition at line 31 of file lte-rlc-header.cc.

ns3::LteRlcHeader::~LteRlcHeader ( )

Definition at line 38 of file lte-rlc-header.cc.

References m_framingInfo, m_headerLength, and m_sequenceNumber.

Member Function Documentation

uint32_t ns3::LteRlcHeader::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should written.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Header.

Definition at line 213 of file lte-rlc-header.cc.

References DATA_FIELD_FOLLOWS, E_LI_FIELDS_FOLLOWS, GetSerializedSize(), m_extensionBits, m_framingInfo, m_headerLength, m_lengthIndicators, m_sequenceNumber, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

uint8_t ns3::LteRlcHeader::GetFramingInfo ( ) const

Definition at line 58 of file lte-rlc-header.cc.

References m_framingInfo.

Referenced by ns3::LteRlcUm::ReassembleAndDeliver().

Here is the caller graph for this function:

TypeId ns3::LteRlcHeader::GetInstanceTypeId ( void ) const

virtual

Returns: the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 125 of file lte-rlc-header.cc.

References GetTypeId().

Here is the call graph for this function:

SequenceNumber10 ns3::LteRlcHeader::GetSequenceNumber ( void ) const

Definition at line 64 of file lte-rlc-header.cc.

References m_sequenceNumber.

Referenced by ns3::LteRlcUm::ReassembleAndDeliver().

Here is the caller graph for this function:

uint32_t ns3::LteRlcHeader::GetSerializedSize ( void ) const

virtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 162 of file lte-rlc-header.cc.

References m_headerLength.

Referenced by Deserialize().

Here is the caller graph for this function:

TypeId ns3::LteRlcHeader::GetTypeId ( void )

static

Reimplemented from ns3::Header.

Definition at line 115 of file lte-rlc-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t ns3::LteRlcHeader::PopExtensionBit ( void )

Definition at line 96 of file lte-rlc-header.cc.

References m_extensionBits.

Referenced by ns3::LteRlcUm::ReassembleAndDeliver().

Here is the caller graph for this function:

uint16_t ns3::LteRlcHeader::PopLengthIndicator ( void )

Definition at line 105 of file lte-rlc-header.cc.

References m_lengthIndicators.

Referenced by ns3::LteRlcUm::ReassembleAndDeliver().

Here is the caller graph for this function:

void ns3::LteRlcHeader::Print ( std::ostream & os ) const

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 130 of file lte-rlc-header.cc.

References m_extensionBits, m_framingInfo, m_headerLength, m_lengthIndicators, and m_sequenceNumber.

void ns3::LteRlcHeader::PushExtensionBit ( uint8_t extensionBit )

Definition at line 71 of file lte-rlc-header.cc.

References m_extensionBits, and m_headerLength.

void ns3::LteRlcHeader::PushLengthIndicator ( uint16_t lengthIndicator )

Definition at line 89 of file lte-rlc-header.cc.

References m_lengthIndicators.

void ns3::LteRlcHeader::Serialize ( Buffer::Iterator start ) const

virtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 167 of file lte-rlc-header.cc.

References ns3::SequenceNumber10::GetValue(), m_extensionBits, m_framingInfo, m_lengthIndicators, m_sequenceNumber, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: