LTE PDCP entity, see 3GPP TS 36.323. More...

#include <lte-pdcp.h>

Inheritance diagram for ns3::LtePdcp:

Collaboration diagram for ns3::LtePdcp:

Classes
struct	Status
	Status variables of the PDCP. More...

Public Types
typedef void(*	PduRxTracedCallback) (const uint16_t rnti, const uint8_t lcid, const uint32_t size, const uint64_t delay)
	TracedCallback signature for PDU receive event. More...

typedef void(*	PduTxTracedCallback) (const uint16_t rnti, const uint8_t lcid, const uint32_t size)
	TracedCallback for PDU transmission event. More...

Public Member Functions
	LtePdcp ()

virtual	~LtePdcp ()

virtual void	DoDispose ()
	Destructor implementation. More...

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)
	Set the status of the PDCP. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

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)
	Copy an Object. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

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

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
	Used to inform of a PDU reception from the RLC SAP user. More...

TracedCallback< uint16_t, uint8_t, uint32_t >	m_txPdu
	Used to inform of a PDU delivery to the RLC SAP provider. More...

Private Attributes
uint16_t	m_rxSequenceNumber

uint16_t	m_txSequenceNumber
	State variables. More...

Static Private Attributes
static const uint16_t	m_maxPdcpSn = 4095
	Constants. More...

Friends
class	LtePdcpSpecificLtePdcpSapProvider< LtePdcp >

class	LtePdcpSpecificLteRlcSapUser

Additional Inherited Members
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

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::LteUeNetDevice/LteUeRrc/DataRadioBearerMap/[i]/LtePdcp"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/Srb0/LtePdcp"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/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::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::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"

No Attributes are defined for this type.

TraceSources

TxPDU: PDU transmission notified to the RLC.
Callback signature: ns3::LtePdcp::PduTxTracedCallback
RxPDU: PDU received.
Callback signature: ns3::LtePdcp::PduRxTracedCallback

Size of this type is 112 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

typedef void(* ns3::LtePdcp::PduRxTracedCallback) (const uint16_t rnti, const uint8_t lcid, const uint32_t size, const uint64_t delay)

TracedCallback signature for PDU receive event.

Parameters

[in]	rnti	The C-RNTI identifying the UE.
[in]	lcid	The logical channel id corresponding to the sending RLC instance.
[in]	size	Packet size.
[in]	delay	Delay since packet sent, in ns..

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

typedef void(* ns3::LtePdcp::PduTxTracedCallback) (const uint16_t rnti, const uint8_t lcid, const uint32_t size)

TracedCallback for PDU transmission event.

Parameters

[in]	rnti	The C-RNTI identifying the UE.
[in]	lcid	The logical channel id corresponding to the sending RLC instance.
[in]	size	Packet size.

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

Constructor & Destructor Documentation

ns3::LtePdcp::LtePdcp ( )

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

References LtePdcpSpecificLteRlcSapUser, m_pdcpSapProvider, m_rlcSapUser, and NS_LOG_FUNCTION.

ns3::LtePdcp::~LtePdcp ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LtePdcp::DoDispose ( void )

virtual

Destructor implementation.

This method is called by 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 101 of file lte-pdcp.cc.

References m_pdcpSapProvider, m_rlcSapUser, and NS_LOG_FUNCTION.

void ns3::LtePdcp::DoReceivePdu ( Ptr< Packet > p )

protectedvirtual

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

References ns3::Packet::FindFirstMatchingByteTag(), ns3::Time::GetNanoSeconds(), ns3::Packet::GetSize(), ns3::LtePdcpSapUser::ReceivePdcpSduParameters::lcid, m_lcid, m_maxPdcpSn, m_pdcpSapUser, m_rnti, m_rxPdu, m_rxSequenceNumber, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LtePdcpSapUser::ReceivePdcpSduParameters::pdcpSdu, ns3::LtePdcpSapUser::ReceivePdcpSdu(), ns3::Packet::RemoveHeader(), and ns3::LtePdcpSapUser::ReceivePdcpSduParameters::rnti.