ns3::LtePdcp Class Reference

#include <lte-pdcp.h>

Inheritance diagram for ns3::LtePdcp:

Classes
struct	Status

Public Member Functions
virtual void	DoDispose ()
LtePdcpSapProvider *	GetLtePdcpSapProvider ()
LteRlcSapUser *	GetLteRlcSapUser ()
Status	GetStatus ()
void	SetLcId (uint8_t lcId)
void	SetLtePdcpSapUser (LtePdcpSapUser *s)
void	SetLteRlcSapProvider (LteRlcSapProvider *s)
void	SetRnti (uint16_t rnti)
void	SetStatus (Status s)
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
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::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Static Public Attributes
static const uint16_t	MAX_PDCP_SN = 4096

Protected Member Functions
virtual void	DoReceivePdu (Ptr< Packet > p)
virtual void	DoTransmitPdcpSdu (Ptr< Packet > p)
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Protected Attributes
uint8_t	m_lcid
LtePdcpSapProvider *	m_pdcpSapProvider
LtePdcpSapUser *	m_pdcpSapUser
LteRlcSapProvider *	m_rlcSapProvider
LteRlcSapUser *	m_rlcSapUser
uint16_t	m_rnti
TracedCallback< uint16_t, uint8_t, uint32_t, uint64_t >	m_rxPdu
TracedCallback< uint16_t, uint8_t, uint32_t >	m_txPdu

Private Attributes
uint16_t	m_rxSequenceNumber
uint16_t	m_txSequenceNumber

Static Private Attributes
static const uint16_t	m_maxPdcpSn = 4095

Friends
class	LtePdcpSpecificLtePdcpSapProvider< LtePdcp >
class	LtePdcpSpecificLteRlcSapUser

Detailed Description

LTE PDCP entity, see 3GPP TS 36.323

Config Paths

ns3::LtePdcp is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/DataRadioBearerMap/[i]/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb0/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb1/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/DataRadioBearerMap/[i]/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb0/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb1/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/DataRadioBearerMap/[i]/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/Srb0/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/Srb1/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/DataRadioBearerMap/[i]/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/Srb0/LtePdcp
• /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/Srb1/LtePdcp

No Attributes are defined for this type.

TraceSources

• TxPDU: PDU transmission notified to the RLC.
• RxPDU: PDU received.

Definition at line 37 of file lte-pdcp.h.

Member Function Documentation

void ns3::LtePdcp::DoDispose ( void  )

virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 100 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

LtePdcpSapProvider * ns3::LtePdcp::GetLtePdcpSapProvider

(

)

Parameters

s	the PDCP SAP Provider interface offered to the RRC by this LTE_PDCP

Definition at line 130 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

LteRlcSapUser * ns3::LtePdcp::GetLteRlcSapUser

(

)

Parameters

s	the RLC SAP User interface offered to the RLC by this LTE_PDCP

Definition at line 144 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

LtePdcp::Status ns3::LtePdcp::GetStatus

(

void

)

Returns

the current status of the PDCP

Definition at line 151 of file lte-pdcp.cc.

References m_txSequenceNumber, ns3::LtePdcp::Status::rxSn, and ns3::LtePdcp::Status::txSn.

void ns3::LtePdcp::SetLcId

(

uint8_t

lcId

)

Parameters

lcId

Definition at line 116 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

void ns3::LtePdcp::SetLtePdcpSapUser

(

LtePdcpSapUser *

s

)

Parameters

s	the PDCP SAP user to be used by this LTE_PDCP

Definition at line 123 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

void ns3::LtePdcp::SetLteRlcSapProvider

(

LteRlcSapProvider *

s

)

Parameters

s	the RLC SAP Provider to be used by this LTE_PDCP

Definition at line 137 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

void ns3::LtePdcp::SetRnti

(

uint16_t

rnti

)

Parameters

rnti

Definition at line 109 of file lte-pdcp.cc.

References NS_LOG_FUNCTION.

void ns3::LtePdcp::SetStatus

(

Status

s

)

Set the status of the PDCP

Parameters

s

Definition at line 160 of file lte-pdcp.cc.

References m_txSequenceNumber, ns3::LtePdcp::Status::rxSn, and ns3::LtePdcp::Status::txSn.

Member Data Documentation

const uint16_t ns3::LtePdcp::m_maxPdcpSn = 4095

staticprivate

Constants. See section 7.2 in TS 36.323

Definition at line 151 of file lte-pdcp.h.

TracedCallback<uint16_t, uint8_t, uint32_t, uint64_t> ns3::LtePdcp::m_rxPdu

protected

Used to inform of a PDU reception from the RLC SAP user. The parameters are RNTI, LCID, bytes delivered and delivery delay in nanoseconds.

Definition at line 139 of file lte-pdcp.h.

TracedCallback<uint16_t, uint8_t, uint32_t> ns3::LtePdcp::m_txPdu

protected

Used to inform of a PDU delivery to the RLC SAP provider. The parameters are RNTI, LCID and bytes delivered

Definition at line 134 of file lte-pdcp.h.

uint16_t ns3::LtePdcp::m_txSequenceNumber

private

State variables. See section 7.1 in TS 36.323

Definition at line 145 of file lte-pdcp.h.

Referenced by GetStatus(), and SetStatus().

---

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

• src/lte/model/lte-pdcp.h
• src/lte/model/lte-pdcp.cc