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
	Get the most derived TypeId for this Object. More...

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

bool	IsNackPresent (SequenceNumber10 nack)

bool	OneMoreNackWouldFitIn (uint16_t bytes)

uint8_t	PopExtensionBit (void)

uint16_t	PopLengthIndicator (void)

int	PopNack (void)
	Retrieve one NACK from the CONTROL PDU. More...

virtual void	Print (std::ostream &os) const

void	PushExtensionBit (uint8_t extensionBit)

void	PushLengthIndicator (uint16_t lengthIndicator)

void	PushNack (int nack)
	Add one more NACK to the CONTROL PDU. More...

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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)

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

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

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

std::list< int >	m_nackSnList

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)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

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

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.
Size of this type is 112 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::LteRlcAmHeader::LteRlcAmHeader ( )

Constructor.

Creates a null header

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

ns3::LteRlcAmHeader::~LteRlcAmHeader ( )

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

References m_ackSn, m_controlPduType, m_dataControlBit, m_framingInfo, m_headerLength, m_lastOffset, 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 read from.

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.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 502 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_nackSnList, 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 286 of file lte-rlc-am-header.cc.

References m_ackSn.

Referenced by ns3::RlcAmStatusPduTestCase::DoRun().

Here is the caller graph for this function:

uint8_t ns3::LteRlcAmHeader::GetFramingInfo ( ) const

Definition at line 96 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

Get the most derived TypeId for this Object.

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

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

Implements ns3::ObjectBase.

Definition at line 304 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 203 of file lte-rlc-am-header.cc.

References m_lastOffset.

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

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

References m_lastSegmentFlag.

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

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

References m_pollingBit.

uint8_t ns3::LteRlcAmHeader::GetResegmentationFlag ( ) const

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

References m_resegmentationFlag.

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

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

References m_segmentOffset.

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

Definition at line 102 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 364 of file lte-rlc-am-header.cc.

References m_headerLength.

Referenced by Deserialize(), and ns3::LteRlcAm::DoNotifyTxOpportunity().

Here is the caller graph for this function:

TypeId ns3::LteRlcAmHeader::GetTypeId ( void )

static

Definition at line 293 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 78 of file lte-rlc-am-header.cc.

References CONTROL_PDU, and m_dataControlBit.

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

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

References DATA_PDU, and m_dataControlBit.

bool ns3::LteRlcAmHeader::IsNackPresent ( SequenceNumber10 nack )

Parameters

nack	SN of the NACK

Returns: true if the NACK is present in the STATUS PDU, false otherwise

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

References CONTROL_PDU, ns3::SequenceNumber10::GetValue(), m_controlPduType, m_dataControlBit, m_nackSnList, NS_ASSERT_MSG, NS_LOG_FUNCTION, and STATUS_PDU.

Here is the call graph for this function:

bool ns3::LteRlcAmHeader::OneMoreNackWouldFitIn ( uint16_t bytes )

Parameters

bytes max allowed CONTROL PDU size

Returns: true if one more NACK would fit in the CONTROL PDU; false otherwise

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

References CONTROL_PDU, m_controlPduType, m_dataControlBit, m_headerLength, m_nackSnList, NS_ASSERT_MSG, NS_LOG_FUNCTION, and STATUS_PDU.

uint8_t ns3::LteRlcAmHeader::PopExtensionBit ( void )

Definition at line 133 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 142 of file lte-rlc-am-header.cc.

References m_lengthIndicators.

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

Here is the caller graph for this function:

int ns3::LteRlcAmHeader::PopNack ( void )

Retrieve one NACK from the CONTROL PDU.

Returns: the SN >= 0 of the next nack; returns -1 if no NACK is left

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

References CONTROL_PDU, m_controlPduType, m_dataControlBit, m_nackSnList, NS_ASSERT_MSG, NS_LOG_FUNCTION, and STATUS_PDU.

Referenced by ns3::RlcAmStatusPduTestCase::DoRun().

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 header as ascii data to a c++ output stream. Although the header 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 310 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_nackSnList, m_pollingBit, m_resegmentationFlag, m_segmentOffset, and m_sequenceNumber.

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

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

References m_extensionBits, and m_headerLength.

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

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

References m_lengthIndicators.

void ns3::LteRlcAmHeader::PushNack ( int nack )

Add one more NACK to the CONTROL PDU.

Parameters

nack

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

References CONTROL_PDU, m_controlPduType, m_dataControlBit, m_headerLength, m_nackSnList, NS_ASSERT_MSG, NS_LOG_FUNCTION, and STATUS_PDU.

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 369 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_nackSnList, m_pollingBit, m_resegmentationFlag, m_segmentOffset, m_sequenceNumber, NS_LOG_LOGIC, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().