A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 Member Functions

 LtePdcp ()
 
virtual ~LtePdcp ()
 
virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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...
 
SimpleRefCountoperator= (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
 
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)
 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)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- 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...
 

Protected Attributes

uint8_t m_lcid
 
LtePdcpSapProviderm_pdcpSapProvider
 
LtePdcpSapUserm_pdcpSapUser
 
LteRlcSapProviderm_rlcSapProvider
 
LteRlcSapUserm_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
 

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.

Constructor & Destructor Documentation

ns3::LtePdcp::LtePdcp ( )
ns3::LtePdcp::~LtePdcp ( )
virtual

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

References NS_LOG_FUNCTION.

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

References m_pdcpSapProvider, m_rlcSapUser, and NS_LOG_FUNCTION.

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

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

References m_pdcpSapProvider, and NS_LOG_FUNCTION.

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

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

References m_rlcSapUser, and NS_LOG_FUNCTION.

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

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

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

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

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

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

+ Here is the call graph for this function:

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

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

References m_lcid, and NS_LOG_FUNCTION.

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

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

References m_pdcpSapUser, NS_LOG_FUNCTION, and s.

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

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

References m_rlcSapProvider, NS_LOG_FUNCTION, and s.

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

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

References m_rnti, and NS_LOG_FUNCTION.

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

Set the status of the PDCP.

Parameters
s

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

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

Friends And Related Function Documentation

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

friend class LtePdcpSpecificLteRlcSapUser
friend

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

Referenced by LtePdcp().

Member Data Documentation

uint8_t ns3::LtePdcp::m_lcid
protected

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

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

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.

Referenced by DoReceivePdu(), and DoTransmitPdcpSdu().

LtePdcpSapProvider* ns3::LtePdcp::m_pdcpSapProvider
protected

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

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

LtePdcpSapUser* ns3::LtePdcp::m_pdcpSapUser
protected

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

Referenced by DoReceivePdu(), and SetLtePdcpSapUser().

LteRlcSapProvider* ns3::LtePdcp::m_rlcSapProvider
protected

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

Referenced by DoTransmitPdcpSdu(), and SetLteRlcSapProvider().

LteRlcSapUser* ns3::LtePdcp::m_rlcSapUser
protected

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

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

uint16_t ns3::LtePdcp::m_rnti
protected

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

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

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.

Referenced by DoReceivePdu(), and GetTypeId().

uint16_t ns3::LtePdcp::m_rxSequenceNumber
private

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

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

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.

Referenced by DoTransmitPdcpSdu(), and GetTypeId().

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 DoTransmitPdcpSdu(), GetStatus(), and SetStatus().

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

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


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