The packet header for the Radio Link Control (RLC) protocol packets. More...
#include "lte-rlc-header.h"
Public Types | |
enum | ExtensionBit_t { DATA_FIELD_FOLLOWS = 0 , E_LI_FIELDS_FOLLOWS = 1 } |
ExtensionBit_t typedef. More... | |
enum | FramingInfoByte_t { FIRST_BYTE = 0x00 , NO_FIRST_BYTE = 0x02 , LAST_BYTE = 0x00 , NO_LAST_BYTE = 0x01 } |
FramingInfoByte_t typedef. More... | |
Public Member Functions | |
LteRlcHeader () | |
Constructor. | |
~LteRlcHeader () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint8_t | GetFramingInfo () const |
Get framing info. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
SequenceNumber10 | GetSequenceNumber () const |
Get sequence number. | |
uint32_t | GetSerializedSize () const override |
uint8_t | PopExtensionBit () |
Pop extension bit. | |
uint16_t | PopLengthIndicator () |
Pop length indicator. | |
void | Print (std::ostream &os) const override |
void | PushExtensionBit (uint8_t extensionBit) |
Push extension bit. | |
void | PushLengthIndicator (uint16_t lengthIndicator) |
Push length indicator. | |
void | Serialize (Buffer::Iterator start) const override |
void | SetFramingInfo (uint8_t framingInfo) |
Set framing info. | |
void | SetSequenceNumber (SequenceNumber10 sequenceNumber) |
Set sequence number. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
std::list< uint8_t > | m_extensionBits |
Includes extensionBit of the fixed part. | |
uint8_t | m_framingInfo |
2 bits | |
uint16_t | m_headerLength |
header length | |
std::list< uint16_t > | m_lengthIndicators |
length indicators | |
SequenceNumber10 | m_sequenceNumber |
sequence number | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
The packet header for the 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.
Group: Lte
Size of this type is 64 bytes (on a 64-bit architecture).
Definition at line 29 of file lte-rlc-header.h.
ExtensionBit_t typedef.
Enumerator | |
---|---|
DATA_FIELD_FOLLOWS | |
E_LI_FIELDS_FOLLOWS |
Definition at line 93 of file lte-rlc-header.h.
FramingInfoByte_t typedef.
Enumerator | |
---|---|
FIRST_BYTE | |
NO_FIRST_BYTE | |
LAST_BYTE | |
NO_LAST_BYTE |
Definition at line 100 of file lte-rlc-header.h.
ns3::LteRlcHeader::LteRlcHeader | ( | ) |
|
override |
Definition at line 27 of file lte-rlc-header.cc.
References m_framingInfo, m_headerLength, and m_sequenceNumber.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 202 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, and ns3::Buffer::Iterator::ReadU8().
uint8_t ns3::LteRlcHeader::GetFramingInfo | ( | ) | const |
Get framing info.
Definition at line 47 of file lte-rlc-header.cc.
References m_framingInfo.
Referenced by ns3::LteRlcUm::ReassembleAndDeliver().
|
overridevirtual |
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.
Implements ns3::ObjectBase.
Definition at line 111 of file lte-rlc-header.cc.
References GetTypeId().
SequenceNumber10 ns3::LteRlcHeader::GetSequenceNumber | ( | ) | const |
Get sequence number.
Definition at line 53 of file lte-rlc-header.cc.
References m_sequenceNumber.
Referenced by ns3::LteRlcUm::DoReceivePdu(), and ns3::LteRlcUm::ReassembleAndDeliver().
|
overridevirtual |
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 150 of file lte-rlc-header.cc.
References m_headerLength.
Referenced by Deserialize(), and ns3::LteRlcUm::DoNotifyTxOpportunity().
|
static |
Get the type ID.
Definition at line 101 of file lte-rlc-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
uint8_t ns3::LteRlcHeader::PopExtensionBit | ( | ) |
Pop extension bit.
Definition at line 83 of file lte-rlc-header.cc.
References m_extensionBits.
Referenced by ns3::LteRlcUm::ReassembleAndDeliver().
uint16_t ns3::LteRlcHeader::PopLengthIndicator | ( | ) |
Pop length indicator.
Definition at line 92 of file lte-rlc-header.cc.
References m_lengthIndicators.
Referenced by ns3::LteRlcUm::ReassembleAndDeliver().
|
overridevirtual |
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 117 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 | ) |
Push extension bit.
extensionBit | the extension bit |
Definition at line 59 of file lte-rlc-header.cc.
References m_extensionBits, and m_headerLength.
Referenced by ns3::LteRlcUm::DoNotifyTxOpportunity().
void ns3::LteRlcHeader::PushLengthIndicator | ( | uint16_t | lengthIndicator | ) |
Push length indicator.
lengthIndicator | the length indicator |
Definition at line 77 of file lte-rlc-header.cc.
References m_lengthIndicators.
Referenced by ns3::LteRlcUm::DoNotifyTxOpportunity().
|
overridevirtual |
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 156 of file lte-rlc-header.cc.
References ns3::SequenceNumber10::GetValue(), m_extensionBits, m_framingInfo, m_lengthIndicators, m_sequenceNumber, and ns3::Buffer::Iterator::WriteU8().
void ns3::LteRlcHeader::SetFramingInfo | ( | uint8_t | framingInfo | ) |
Set framing info.
framingInfo | framing info |
Definition at line 35 of file lte-rlc-header.cc.
References m_framingInfo.
Referenced by ns3::LteRlcUm::DoNotifyTxOpportunity().
void ns3::LteRlcHeader::SetSequenceNumber | ( | SequenceNumber10 | sequenceNumber | ) |
Set sequence number.
sequenceNumber | sequence number |
Definition at line 41 of file lte-rlc-header.cc.
References m_sequenceNumber.
Referenced by ns3::LteRlcUm::DoNotifyTxOpportunity().
|
private |
Includes extensionBit of the fixed part.
Definition at line 124 of file lte-rlc-header.h.
Referenced by Deserialize(), PopExtensionBit(), Print(), PushExtensionBit(), and Serialize().
|
private |
2 bits
Definition at line 121 of file lte-rlc-header.h.
Referenced by ~LteRlcHeader(), Deserialize(), GetFramingInfo(), Print(), Serialize(), and SetFramingInfo().
|
private |
header length
Definition at line 120 of file lte-rlc-header.h.
Referenced by ~LteRlcHeader(), Deserialize(), GetSerializedSize(), Print(), and PushExtensionBit().
|
private |
length indicators
Definition at line 125 of file lte-rlc-header.h.
Referenced by Deserialize(), PopLengthIndicator(), Print(), PushLengthIndicator(), and Serialize().
|
private |
sequence number
Definition at line 122 of file lte-rlc-header.h.
Referenced by ~LteRlcHeader(), Deserialize(), GetSequenceNumber(), Print(), Serialize(), and SetSequenceNumber().