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

#include <lte-rlc-am-header.h>

Inheritance diagram for ns3::LteRlcAmHeader:

Collaboration diagram for ns3::LteRlcAmHeader:

Public Types
enum	ControPduType_t { STATUS_PDU = 000 }

enum	DataControlPdu_t { CONTROL_PDU = 0, DATA_PDU = 1 }

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 }

enum	LastSegmentFlag_t { NO_LAST_PDU_SEGMENT = 0, LAST_PDU_SEGMENT = 1 }

enum	PollingBit_t { STATUS_REPORT_NOT_REQUESTED = 0, STATUS_REPORT_IS_REQUESTED = 1 }

enum	ResegmentationFlag_t { PDU = 0, SEGMENT = 1 }

Public Member Functions
	LteRlcAmHeader ()
	Constructor. More...

	~LteRlcAmHeader ()

virtual uint32_t	Deserialize (Buffer::Iterator start)

SequenceNumber10	GetAckSn () const

uint8_t	GetFramingInfo () const

virtual TypeId	GetInstanceTypeId (void) const

uint16_t	GetLastOffset () const

uint8_t	GetLastSegmentFlag () const

uint8_t	GetPollingBit () const

uint8_t	GetResegmentationFlag () const

uint16_t	GetSegmentOffset () const

SequenceNumber10	GetSequenceNumber () const

virtual uint32_t	GetSerializedSize (void) const

bool	IsControlPdu (void) const

bool	IsDataPdu (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	SetAckSn (SequenceNumber10 ackSn)

void	SetControlPdu (uint8_t controlPduType)

void	SetDataPdu (void)

void	SetFramingInfo (uint8_t framingInfo)

void	SetLastSegmentFlag (uint8_t lsf)

void	SetPollingBit (uint8_t pollingBit)

void	SetResegmentationFlag (uint8_t resegFlag)

void	SetSegmentOffset (uint16_t segmentOffset)

void	SetSequenceNumber (SequenceNumber10 sequenceNumber)

Public Member Functions inherited from ns3::Header
virtual	~Header ()

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
SequenceNumber10	m_ackSn

uint8_t	m_controlPduType

uint8_t	m_dataControlBit

std::list< uint8_t >	m_extensionBits

std::list< uint8_t >	m_extensionBits1

std::list< uint8_t >	m_extensionBits2

uint8_t	m_framingInfo

uint16_t	m_headerLength

uint16_t	m_lastOffset

uint8_t	m_lastSegmentFlag

std::list< uint16_t >	m_lengthIndicators

SequenceNumber10	m_nackSn

uint8_t	m_pollingBit

uint8_t	m_resegmentationFlag

uint16_t	m_segmentOffset

SequenceNumber10	m_sequenceNumber

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

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

Doxygen introspection did not find any typical Config paths.

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.

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Enumeration Documentation

enum ns3::LteRlcAmHeader::ControPduType_t

Enumerator
STATUS_PDU

Definition at line 61 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::DataControlPdu_t

Enumerator
CONTROL_PDU
DATA_PDU

Definition at line 56 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::ExtensionBit_t

Enumerator
DATA_FIELD_FOLLOWS
E_LI_FIELDS_FOLLOWS

Definition at line 91 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::FramingInfoFirstByte_t

Enumerator
FIRST_BYTE
NO_FIRST_BYTE

Definition at line 75 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::FramingInfoLastByte_t

Enumerator
LAST_BYTE
NO_LAST_BYTE

Definition at line 80 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::LastSegmentFlag_t

Enumerator
NO_LAST_PDU_SEGMENT
LAST_PDU_SEGMENT

Definition at line 115 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::PollingBit_t

Enumerator
STATUS_REPORT_NOT_REQUESTED
STATUS_REPORT_IS_REQUESTED

Definition at line 107 of file lte-rlc-am-header.h.

enum ns3::LteRlcAmHeader::ResegmentationFlag_t

Enumerator
PDU
SEGMENT

Definition at line 99 of file lte-rlc-am-header.h.

Constructor & Destructor Documentation

ns3::LteRlcAmHeader::LteRlcAmHeader ( )

Constructor.

Creates a null header

Definition at line 32 of file lte-rlc-am-header.cc.

ns3::LteRlcAmHeader::~LteRlcAmHeader ( )

Definition at line 47 of file lte-rlc-am-header.cc.

References m_ackSn, m_controlPduType, m_dataControlBit, m_framingInfo, m_headerLength, m_lastOffset, m_nackSn, m_pollingBit, m_resegmentationFlag, m_segmentOffset, and m_sequenceNumber.

Member Function Documentation

uint32_t ns3::LteRlcAmHeader::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 355 of file lte-rlc-am-header.cc.

References DATA_FIELD_FOLLOWS, DATA_PDU, E_LI_FIELDS_FOLLOWS, GetSerializedSize(), ns3::Buffer::Iterator::GetSize(), m_ackSn, m_controlPduType, m_dataControlBit, m_extensionBits, m_framingInfo, m_headerLength, m_lastOffset, m_lastSegmentFlag, m_lengthIndicators, m_pollingBit, m_resegmentationFlag, m_segmentOffset, m_sequenceNumber, ns3::Buffer::Iterator::ReadU8(), SEGMENT, and visualizer.core::start().

Here is the call graph for this function:

SequenceNumber10 ns3::LteRlcAmHeader::GetAckSn ( void ) const

Definition at line 219 of file lte-rlc-am-header.cc.

References m_ackSn.

uint8_t ns3::LteRlcAmHeader::GetFramingInfo ( ) const

Definition at line 99 of file lte-rlc-am-header.cc.

References m_framingInfo.

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

Here is the caller graph for this function:

TypeId ns3::LteRlcAmHeader::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 236 of file lte-rlc-am-header.cc.

References GetTypeId().

Here is the call graph for this function:

uint16_t ns3::LteRlcAmHeader::GetLastOffset ( void ) const

Definition at line 206 of file lte-rlc-am-header.cc.

References m_lastOffset.

uint8_t ns3::LteRlcAmHeader::GetLastSegmentFlag ( void ) const

Definition at line 187 of file lte-rlc-am-header.cc.

References m_lastSegmentFlag.

uint8_t ns3::LteRlcAmHeader::GetPollingBit ( void ) const

Definition at line 174 of file lte-rlc-am-header.cc.

References m_pollingBit.

uint8_t ns3::LteRlcAmHeader::GetResegmentationFlag ( ) const

Definition at line 161 of file lte-rlc-am-header.cc.

References m_resegmentationFlag.

uint16_t ns3::LteRlcAmHeader::GetSegmentOffset ( void ) const

Definition at line 200 of file lte-rlc-am-header.cc.

References m_segmentOffset.

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

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

References m_sequenceNumber.

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

Here is the caller graph for this function:

uint32_t ns3::LteRlcAmHeader::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 288 of file lte-rlc-am-header.cc.

References m_headerLength.

Referenced by Deserialize().

Here is the caller graph for this function:

TypeId ns3::LteRlcAmHeader::GetTypeId ( void )

static

Definition at line 226 of file lte-rlc-am-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:

bool ns3::LteRlcAmHeader::IsControlPdu ( void ) const

Definition at line 81 of file lte-rlc-am-header.cc.

References CONTROL_PDU, and m_dataControlBit.

bool ns3::LteRlcAmHeader::IsDataPdu ( void ) const

Definition at line 76 of file lte-rlc-am-header.cc.

References DATA_PDU, and m_dataControlBit.

uint8_t ns3::LteRlcAmHeader::PopExtensionBit ( void )

Definition at line 136 of file lte-rlc-am-header.cc.

References m_extensionBits.

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

Here is the caller graph for this function:

uint16_t ns3::LteRlcAmHeader::PopLengthIndicator ( void )

Definition at line 145 of file lte-rlc-am-header.cc.

References m_lengthIndicators.

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

Here is the caller graph for this function:

void ns3::LteRlcAmHeader::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 242 of file lte-rlc-am-header.cc.

References DATA_PDU, m_ackSn, m_dataControlBit, m_extensionBits, m_framingInfo, m_headerLength, m_lastSegmentFlag, m_lengthIndicators, m_nackSn, m_pollingBit, m_resegmentationFlag, m_segmentOffset, and m_sequenceNumber.

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

Definition at line 112 of file lte-rlc-am-header.cc.

References m_extensionBits, and m_headerLength.

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

Definition at line 129 of file lte-rlc-am-header.cc.

References m_lengthIndicators.

void ns3::LteRlcAmHeader::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 293 of file lte-rlc-am-header.cc.

References CONTROL_PDU, DATA_PDU, ns3::SequenceNumber10::GetValue(), m_ackSn, m_controlPduType, m_dataControlBit, m_extensionBits, m_framingInfo, m_lastSegmentFlag, m_lengthIndicators, m_pollingBit, m_resegmentationFlag, m_segmentOffset, m_sequenceNumber, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().