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

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) (uint16_t rnti, uint8_t lcid, uint32_t size)
 TracedCallback for PDU transmission event. More...
 

Public Member Functions

 LtePdcp ()
 
virtual ~LtePdcp ()
 
virtual void DoDispose ()
 Destructor implementation. More...
 
LtePdcpSapProviderGetLtePdcpSapProvider ()
 
LteRlcSapUserGetLteRlcSapUser ()
 
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
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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::Object
static TypeId GetTypeId (void)
 Register this type. 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
 maximum PDCP SN More...
 

Protected Member Functions

virtual void DoReceivePdu (Ptr< Packet > p)
 Interface provided to lower RLC entity. More...
 
virtual void DoTransmitPdcpSdu (LtePdcpSapProvider::TransmitPdcpSduParameters params)
 Interface provided to upper RRC entity. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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
 LCID. More...
 
LtePdcpSapProviderm_pdcpSapProvider
 PDCP SAP provider. More...
 
LtePdcpSapUserm_pdcpSapUser
 PDCP SAP user. More...
 
LteRlcSapProviderm_rlcSapProvider
 RLC SAP provider. More...
 
LteRlcSapUserm_rlcSapUser
 RLC SAP user. More...
 
uint16_t m_rnti
 RNTI. More...
 
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_tm_txPdu
 Used to inform of a PDU delivery to the RLC SAP provider. More...
 

Private Attributes

uint16_t m_rxSequenceNumber
 State variables. More...
 
uint16_t m_txSequenceNumber
 State variables. More...
 

Static Private Attributes

static const uint16_t m_maxPdcpSn = 4095
 Constants. More...
 

Friends

class LtePdcpSpecificLtePdcpSapProvider< LtePdcp >
 allow LtePdcpSpecificLtePdcpSapProvider<LtePdcp> class friend access More...
 
class LtePdcpSpecificLteRlcSapUser
 allow LtePdcpSpecificLteRlcSapUser class friend access More...
 

Additional Inherited Members

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

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

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

Member Typedef Documentation

◆ PduRxTracedCallback

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]rntiThe C-RNTI identifying the UE.
[in]lcidThe logical channel id corresponding to the sending RLC instance.
[in]sizePacket size.
[in]delayDelay since packet sent, in ns..

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

◆ PduTxTracedCallback

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

TracedCallback for PDU transmission event.

Parameters
[in]rntiThe C-RNTI identifying the UE.
[in]lcidThe logical channel id corresponding to the sending RLC instance.
[in]sizePacket size.

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

Constructor & Destructor Documentation

◆ LtePdcp()

◆ ~LtePdcp()

ns3::LtePdcp::~LtePdcp ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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 overridden 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 108 of file lte-pdcp.cc.

References m_pdcpSapProvider, m_rlcSapUser, and NS_LOG_FUNCTION.

◆ DoReceivePdu()

◆ DoTransmitPdcpSdu()

◆ GetLtePdcpSapProvider()

LtePdcpSapProvider * ns3::LtePdcp::GetLtePdcpSapProvider ( )
Returns
the PDCP SAP Provider interface offered to the RRC by this LTE_PDCP

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

References m_pdcpSapProvider, and NS_LOG_FUNCTION.

◆ GetLteRlcSapUser()

LteRlcSapUser * ns3::LtePdcp::GetLteRlcSapUser ( )
Returns
the RLC SAP User interface offered to the RLC by this LTE_PDCP

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

References m_rlcSapUser, and NS_LOG_FUNCTION.

◆ GetStatus()

LtePdcp::Status ns3::LtePdcp::GetStatus ( void  )
Returns
the current status of the PDCP

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

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

◆ GetTypeId()

TypeId ns3::LtePdcp::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References m_rxPdu, m_txPdu, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetLcId()

void ns3::LtePdcp::SetLcId ( uint8_t  lcId)
Parameters
lcId

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

References m_lcid, and NS_LOG_FUNCTION.

◆ SetLtePdcpSapUser()

void ns3::LtePdcp::SetLtePdcpSapUser ( LtePdcpSapUser s)
Parameters
sthe PDCP SAP user to be used by this LTE_PDCP

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

References m_pdcpSapUser, and NS_LOG_FUNCTION.

◆ SetLteRlcSapProvider()

void ns3::LtePdcp::SetLteRlcSapProvider ( LteRlcSapProvider s)
Parameters
sthe RLC SAP Provider to be used by this LTE_PDCP

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

References m_rlcSapProvider, and NS_LOG_FUNCTION.

◆ SetRnti()

void ns3::LtePdcp::SetRnti ( uint16_t  rnti)
Parameters
rnti

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

References m_rnti, and NS_LOG_FUNCTION.

◆ SetStatus()

void ns3::LtePdcp::SetStatus ( Status  s)

Set the status of the PDCP.

Parameters
s

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

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

Friends And Related Function Documentation

◆ LtePdcpSpecificLtePdcpSapProvider< LtePdcp >

allow LtePdcpSpecificLtePdcpSapProvider<LtePdcp> class friend access

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

Referenced by LtePdcp().

◆ LtePdcpSpecificLteRlcSapUser

friend class LtePdcpSpecificLteRlcSapUser
friend

allow LtePdcpSpecificLteRlcSapUser class friend access

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

Referenced by LtePdcp().

Member Data Documentation

◆ m_lcid

uint8_t ns3::LtePdcp::m_lcid
protected

LCID.

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

Referenced by DoReceivePdu(), DoTransmitPdcpSdu(), and SetLcId().

◆ m_maxPdcpSn

const uint16_t ns3::LtePdcp::m_maxPdcpSn = 4095
staticprivate

Constants.

See section 7.2 in TS 36.323

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

Referenced by DoReceivePdu(), and DoTransmitPdcpSdu().

◆ m_pdcpSapProvider

LtePdcpSapProvider* ns3::LtePdcp::m_pdcpSapProvider
protected

PDCP SAP provider.

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

Referenced by LtePdcp(), DoDispose(), and GetLtePdcpSapProvider().

◆ m_pdcpSapUser

LtePdcpSapUser* ns3::LtePdcp::m_pdcpSapUser
protected

PDCP SAP user.

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

Referenced by DoReceivePdu(), and SetLtePdcpSapUser().

◆ m_rlcSapProvider

LteRlcSapProvider* ns3::LtePdcp::m_rlcSapProvider
protected

RLC SAP provider.

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

Referenced by DoTransmitPdcpSdu(), and SetLteRlcSapProvider().

◆ m_rlcSapUser

LteRlcSapUser* ns3::LtePdcp::m_rlcSapUser
protected

RLC SAP user.

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

Referenced by LtePdcp(), DoDispose(), and GetLteRlcSapUser().

◆ m_rnti

uint16_t ns3::LtePdcp::m_rnti
protected

RNTI.

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

Referenced by DoReceivePdu(), DoTransmitPdcpSdu(), and SetRnti().

◆ m_rxPdu

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 177 of file lte-pdcp.h.

Referenced by DoReceivePdu(), and GetTypeId().

◆ m_rxSequenceNumber

uint16_t ns3::LtePdcp::m_rxSequenceNumber
private

State variables.

See section 7.1 in TS 36.323

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

Referenced by DoReceivePdu(), GetStatus(), and SetStatus().

◆ m_txPdu

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 172 of file lte-pdcp.h.

Referenced by DoTransmitPdcpSdu(), and GetTypeId().

◆ m_txSequenceNumber

uint16_t ns3::LtePdcp::m_txSequenceNumber
private

State variables.

See section 7.1 in TS 36.323

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

Referenced by DoTransmitPdcpSdu(), GetStatus(), and SetStatus().

◆ MAX_PDCP_SN

const uint16_t ns3::LtePdcp::MAX_PDCP_SN = 4096
static

maximum PDCP SN

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


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