The packet header for the Packet Data Convergence Protocol (PDCP) packets. More...

#include <lte-pdcp-header.h>

Inheritance diagram for ns3::LtePdcpHeader:

Collaboration diagram for ns3::LtePdcpHeader:

Public Types
enum	DcBit_t { CONTROL_PDU = 0, DATA_PDU = 1 }

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

	~LtePdcpHeader ()

virtual uint32_t	Deserialize (Buffer::Iterator start)

uint8_t	GetDcBit () const

virtual TypeId	GetInstanceTypeId (void) const

uint16_t	GetSequenceNumber () const

virtual uint32_t	GetSerializedSize (void) const

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetDcBit (uint8_t dcBit)

void	SetSequenceNumber (uint16_t 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
uint8_t	m_dcBit

uint16_t	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 Packet Data Convergence Protocol (PDCP) packets.

Doxygen introspection did not find any typical Config paths.

This class has fields corresponding to those in an PDCP header as well as methods for serialization to and deserialization from a byte buffer. It follows 3GPP TS 36.323 Packet Data Convergence Protocol (PDCP) specification.

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

Definition at line 38 of file lte-pdcp-header.h.

Member Enumeration Documentation

enum ns3::LtePdcpHeader::DcBit_t

Enumerator
CONTROL_PDU
DATA_PDU

Definition at line 56 of file lte-pdcp-header.h.

Constructor & Destructor Documentation

ns3::LtePdcpHeader::LtePdcpHeader ( )

Constructor.

Creates a null header

Definition at line 32 of file lte-pdcp-header.cc.

ns3::LtePdcpHeader::~LtePdcpHeader ( )

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

References m_dcBit, and m_sequenceNumber.

Member Function Documentation

uint32_t ns3::LtePdcpHeader::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 104 of file lte-pdcp-header.cc.

References DATA_PDU, GetSerializedSize(), m_dcBit, m_sequenceNumber, NS_ASSERT, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

uint8_t ns3::LtePdcpHeader::GetDcBit ( ) const

Definition at line 57 of file lte-pdcp-header.cc.

References m_dcBit.

TypeId ns3::LtePdcpHeader::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 80 of file lte-pdcp-header.cc.

References GetTypeId().

Here is the call graph for this function:

uint16_t ns3::LtePdcpHeader::GetSequenceNumber ( void ) const

Definition at line 63 of file lte-pdcp-header.cc.

References m_sequenceNumber.

uint32_t ns3::LtePdcpHeader::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 91 of file lte-pdcp-header.cc.

Referenced by Deserialize().

Here is the caller graph for this function:

TypeId ns3::LtePdcpHeader::GetTypeId ( void )

static

Definition at line 70 of file lte-pdcp-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:

void ns3::LtePdcpHeader::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 85 of file lte-pdcp-header.cc.

References m_dcBit, and m_sequenceNumber.

void ns3::LtePdcpHeader::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 96 of file lte-pdcp-header.cc.

References m_dcBit, m_sequenceNumber, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: