A Discrete-Event Network Simulator
API
ns3::LteRlcAmHeader Class Reference

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 }
 ControlPduType_t enumeration. More...
 
enum  DataControlPdu_t { CONTROL_PDU = 0, DATA_PDU = 1 }
 DataControlPdu_t enumeration. More...
 
enum  ExtensionBit_t { DATA_FIELD_FOLLOWS = 0, E_LI_FIELDS_FOLLOWS = 1 }
 ExtensionBit_t typedef. More...
 
enum  FramingInfoFirstByte_t { FIRST_BYTE = 0x00, NO_FIRST_BYTE = 0x02 }
 FramingInfoFirstByte_t enumeration. More...
 
enum  FramingInfoLastByte_t { LAST_BYTE = 0x00, NO_LAST_BYTE = 0x01 }
 FramingInfoLastByte_t enumeration. More...
 
enum  LastSegmentFlag_t { NO_LAST_PDU_SEGMENT = 0, LAST_PDU_SEGMENT = 1 }
 LastSegmentFlag_t typedef. More...
 
enum  PollingBit_t { STATUS_REPORT_NOT_REQUESTED = 0, STATUS_REPORT_IS_REQUESTED = 1 }
 PollingBit_t enumeration. More...
 
enum  ResegmentationFlag_t { PDU = 0, SEGMENT = 1 }
 ResegmentationFlag_t typedef. More...
 

Public Member Functions

 LteRlcAmHeader ()
 Constructor. More...
 
 ~LteRlcAmHeader ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
SequenceNumber10 GetAckSn () const
 Get ack sn function. More...
 
uint8_t GetFramingInfo () const
 Get framing info. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint16_t GetLastOffset () const
 Get last offset function. More...
 
uint8_t GetLastSegmentFlag () const
 Get last segment flag function. More...
 
uint8_t GetPollingBit () const
 Get polling bit function. More...
 
uint8_t GetResegmentationFlag () const
 Get resegmentation flag function. More...
 
uint16_t GetSegmentOffset () const
 Get segment offset function. More...
 
SequenceNumber10 GetSequenceNumber () const
 Get sequence number. More...
 
virtual uint32_t GetSerializedSize (void) const
 
bool IsControlPdu (void) const
 Is control PDU function. More...
 
bool IsDataPdu (void) const
 Is data PDU function. More...
 
bool IsNackPresent (SequenceNumber10 nack)
 
bool OneMoreNackWouldFitIn (uint16_t bytes)
 
uint8_t PopExtensionBit (void)
 Pop extension bit function. More...
 
uint16_t PopLengthIndicator (void)
 Pop length indicator function. More...
 
int PopNack (void)
 Retrieve one NACK from the CONTROL PDU. More...
 
virtual void Print (std::ostream &os) const
 
void PushExtensionBit (uint8_t extensionBit)
 Push extension bit function. More...
 
void PushLengthIndicator (uint16_t lengthIndicator)
 Push length indicator function. More...
 
void PushNack (int nack)
 Add one more NACK to the CONTROL PDU. More...
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetAckSn (SequenceNumber10 ackSn)
 Set ack sn function. More...
 
void SetControlPdu (uint8_t controlPduType)
 Set control PDU function. More...
 
void SetDataPdu (void)
 Set data PDU function. More...
 
void SetFramingInfo (uint8_t framingInfo)
 Set sequence number. More...
 
void SetLastSegmentFlag (uint8_t lsf)
 Set last segment flag function. More...
 
void SetPollingBit (uint8_t pollingBit)
 Set polling bit function. More...
 
void SetResegmentationFlag (uint8_t resegFlag)
 Pop extension bit function. More...
 
void SetSegmentOffset (uint16_t segmentOffset)
 Set segment offset function. More...
 
void SetSequenceNumber (SequenceNumber10 sequenceNumber)
 Set sequence number. More...
 
- 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)
 Get the type ID. More...
 
- 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
 ack sn More...
 
uint8_t m_controlPduType
 control PDU type More...
 
uint8_t m_dataControlBit
 data control bit More...
 
std::list< uint8_t > m_extensionBits
 Includes extensionBit of the fixed part. More...
 
std::list< uint8_t > m_extensionBits1
 Includes E1 after ACK_SN. More...
 
std::list< uint8_t > m_extensionBits2
 extension bits 2 More...
 
uint8_t m_framingInfo
 2 bits More...
 
uint16_t m_headerLength
 header length More...
 
uint16_t m_lastOffset
 last offset More...
 
uint8_t m_lastSegmentFlag
 last segment flag More...
 
std::list< uint16_t > m_lengthIndicators
 length indicators More...
 
std::list< int > m_nackSnList
 nack sn list More...
 
uint8_t m_pollingBit
 polling bit More...
 
uint8_t m_resegmentationFlag
 resegmentation flag More...
 
uint16_t m_segmentOffset
 segment offset More...
 
SequenceNumber10 m_sequenceNumber
 sequence number More...
 

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...
 

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.

Member Function Documentation

uint32_t ns3::LteRlcAmHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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

Get ack sn function.

Returns
sequence numbr

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

Get framing info.

Returns
framing info

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

Get last offset function.

Returns
last offset

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

References m_lastOffset.

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

Get last segment flag function.

Returns
last segment flag

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

References m_lastSegmentFlag.

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

Get polling bit function.

Returns
polling bit

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

References m_pollingBit.

uint8_t ns3::LteRlcAmHeader::GetResegmentationFlag ( ) const

Get resegmentation flag function.

Returns
resegmentation flag

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

References m_resegmentationFlag.

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

Get segment offset function.

Returns
segment offset

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

References m_segmentOffset.

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

Get sequence number.

Returns
sequence number

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

Get the type ID.

Returns
the object TypeId

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

Is control PDU function.

Returns
true if control PDU

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

References CONTROL_PDU, and m_dataControlBit.

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

Is data PDU function.

Returns
true if data PDU

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

References DATA_PDU, and m_dataControlBit.

bool ns3::LteRlcAmHeader::IsNackPresent ( SequenceNumber10  nack)
Parameters
nackSN 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
bytesmax 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  )

Pop extension bit function.

Returns
the extension bit

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  )

Pop length indicator function.

Returns
the length indicator

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
osoutput 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)

Push extension bit function.

Parameters
extensionBitthe extension bit

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

References m_extensionBits, and m_headerLength.

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

Push length indicator function.

Parameters
lengthIndicatorthe length indicator

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
startan 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().

+ Here is the call graph for this function:

void ns3::LteRlcAmHeader::SetAckSn ( SequenceNumber10  ackSn)

Set ack sn function.

Parameters
ackSnack sn

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

References m_ackSn.

void ns3::LteRlcAmHeader::SetControlPdu ( uint8_t  controlPduType)

Set control PDU function.

Parameters
controlPduType

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

References CONTROL_PDU, m_controlPduType, m_dataControlBit, and m_headerLength.

Referenced by ns3::LteRlcAm::DoNotifyTxOpportunity(), and ns3::RlcAmStatusPduTestCase::DoRun().

+ Here is the caller graph for this function:

void ns3::LteRlcAmHeader::SetDataPdu ( void  )

Set data PDU function.

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

References DATA_PDU, m_dataControlBit, and m_headerLength.

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

+ Here is the caller graph for this function:

void ns3::LteRlcAmHeader::SetFramingInfo ( uint8_t  framingInfo)

Set sequence number.

Parameters
framingInfoframing info

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

References m_framingInfo.

void ns3::LteRlcAmHeader::SetLastSegmentFlag ( uint8_t  lsf)

Set last segment flag function.

Parameters
lsflast segment flag

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

References m_lastSegmentFlag.

void ns3::LteRlcAmHeader::SetPollingBit ( uint8_t  pollingBit)

Set polling bit function.

Parameters
pollingBitpolling bit

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

References m_pollingBit.

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

+ Here is the caller graph for this function:

void ns3::LteRlcAmHeader::SetResegmentationFlag ( uint8_t  resegFlag)

Pop extension bit function.

Parameters
resegFlagresegmentation flag

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

References m_resegmentationFlag.

void ns3::LteRlcAmHeader::SetSegmentOffset ( uint16_t  segmentOffset)

Set segment offset function.

Parameters
segmentOffsetsegment offset

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

References m_segmentOffset.

void ns3::LteRlcAmHeader::SetSequenceNumber ( SequenceNumber10  sequenceNumber)

Set sequence number.

Parameters
sequenceNumbersequence number

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

References m_sequenceNumber.

Member Data Documentation

SequenceNumber10 ns3::LteRlcAmHeader::m_ackSn
private

ack sn

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

Referenced by Deserialize(), GetAckSn(), Print(), Serialize(), SetAckSn(), and ~LteRlcAmHeader().

uint8_t ns3::LteRlcAmHeader::m_controlPduType
private
uint8_t ns3::LteRlcAmHeader::m_dataControlBit
private
std::list<uint8_t> ns3::LteRlcAmHeader::m_extensionBits
private

Includes extensionBit of the fixed part.

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

Referenced by Deserialize(), PopExtensionBit(), Print(), PushExtensionBit(), and Serialize().

std::list<uint8_t> ns3::LteRlcAmHeader::m_extensionBits1
private

Includes E1 after ACK_SN.

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

std::list<uint8_t> ns3::LteRlcAmHeader::m_extensionBits2
private

extension bits 2

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

uint8_t ns3::LteRlcAmHeader::m_framingInfo
private

2 bits

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

Referenced by Deserialize(), GetFramingInfo(), Print(), Serialize(), SetFramingInfo(), and ~LteRlcAmHeader().

uint16_t ns3::LteRlcAmHeader::m_headerLength
private
uint16_t ns3::LteRlcAmHeader::m_lastOffset
private

last offset

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

Referenced by Deserialize(), GetLastOffset(), and ~LteRlcAmHeader().

uint8_t ns3::LteRlcAmHeader::m_lastSegmentFlag
private

last segment flag

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

Referenced by Deserialize(), GetLastSegmentFlag(), Print(), Serialize(), and SetLastSegmentFlag().

std::list<uint16_t> ns3::LteRlcAmHeader::m_lengthIndicators
private

length indicators

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

Referenced by Deserialize(), PopLengthIndicator(), Print(), PushLengthIndicator(), and Serialize().

std::list<int> ns3::LteRlcAmHeader::m_nackSnList
private

nack sn list

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

Referenced by Deserialize(), IsNackPresent(), OneMoreNackWouldFitIn(), PopNack(), Print(), PushNack(), and Serialize().

uint8_t ns3::LteRlcAmHeader::m_pollingBit
private

polling bit

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

Referenced by Deserialize(), GetPollingBit(), Print(), Serialize(), SetPollingBit(), and ~LteRlcAmHeader().

uint8_t ns3::LteRlcAmHeader::m_resegmentationFlag
private

resegmentation flag

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

Referenced by Deserialize(), GetResegmentationFlag(), Print(), Serialize(), SetResegmentationFlag(), and ~LteRlcAmHeader().

uint16_t ns3::LteRlcAmHeader::m_segmentOffset
private

segment offset

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

Referenced by Deserialize(), GetSegmentOffset(), Print(), Serialize(), SetSegmentOffset(), and ~LteRlcAmHeader().

SequenceNumber10 ns3::LteRlcAmHeader::m_sequenceNumber
private

sequence number

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

Referenced by Deserialize(), GetSequenceNumber(), Print(), Serialize(), SetSequenceNumber(), and ~LteRlcAmHeader().


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