A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ns3::LteRlc Class Referenceabstract

This abstract base class defines the API to interact with the Radio Link Control (LTE_RLC) in LTE, see 3GPP TS 36.322. More...

#include <lte-rlc.h>

+ Inheritance diagram for ns3::LteRlc:
+ Collaboration diagram for ns3::LteRlc:

Public Member Functions

 LteRlc ()
 
virtual ~LteRlc ()
 
virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
LteMacSapUser * GetLteMacSapUser ()
 
LteRlcSapProvider * GetLteRlcSapProvider ()
 
void SetLcId (uint8_t lcId)
 
void SetLteMacSapProvider (LteMacSapProvider *s)
 
void SetLteRlcSapUser (LteRlcSapUser *s)
 
void SetRnti (uint16_t rnti)
 
- 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...
 
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
 
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...
 

Protected Member Functions

virtual void DoNotifyHarqDeliveryFailure ()=0
 
virtual void DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId)=0
 
virtual void DoReceivePdu (Ptr< Packet > p)=0
 
virtual void DoTransmitPdcpPdu (Ptr< Packet > p)=0
 
- 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
 
LteMacSapProvider * m_macSapProvider
 
LteMacSapUser * m_macSapUser
 
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 MAC SAP user. More...
 
TracedCallback< uint16_t,
uint8_t, uint32_t > 		m_txPdu
 Used to inform of a PDU delivery to the MAC SAP provider. More...
 

Friends

class LteRlcSpecificLteMacSapUser
 
class LteRlcSpecificLteRlcSapProvider< LteRlc >
 

Detailed Description

This abstract base class defines the API to interact with the Radio Link Control (LTE_RLC) in LTE, see 3GPP TS 36.322.

Config Paths

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

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

No Attributes are defined for this type.

TraceSources

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

Definition at line 50 of file lte-rlc.h.

Constructor & Destructor Documentation

ns3::LteRlc::LteRlc ( )

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

References LteRlcSpecificLteMacSapUser, m_macSapUser, m_rlcSapProvider, and NS_LOG_FUNCTION.

ns3::LteRlc::~LteRlc ( )
virtual

Definition at line 97 of file lte-rlc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteRlc::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.

Reimplemented in ns3::LteRlcSm, ns3::LteRlcAm, ns3::LteRlcTm, and ns3::LteRlcUm.

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

References m_macSapUser, m_rlcSapProvider, and NS_LOG_FUNCTION.

Referenced by ns3::LteRlcTm::DoDispose(), ns3::LteRlcUm::DoDispose(), ns3::LteRlcAm::DoDispose(), and ns3::LteRlcSm::DoDispose().

+ Here is the caller graph for this function:

virtual void ns3::LteRlc::DoNotifyHarqDeliveryFailure ( )
protectedpure virtual

Implemented in ns3::LteRlcSm, ns3::LteRlcAm, ns3::LteRlcTm, and ns3::LteRlcUm.

Referenced by ns3::LteRlcSpecificLteMacSapUser::NotifyHarqDeliveryFailure().

+ Here is the caller graph for this function:

virtual void ns3::LteRlc::DoNotifyTxOpportunity ( uint32_t  bytes,
uint8_t  layer,
uint8_t  harqId 
)
protectedpure virtual

Implemented in ns3::LteRlcSm, ns3::LteRlcAm, ns3::LteRlcTm, and ns3::LteRlcUm.

Referenced by ns3::LteRlcSpecificLteMacSapUser::NotifyTxOpportunity().

+ Here is the caller graph for this function:

virtual void ns3::LteRlc::DoReceivePdu ( Ptr< Packet >  p)
protectedpure virtual

Implemented in ns3::LteRlcSm, ns3::LteRlcAm, ns3::LteRlcTm, and ns3::LteRlcUm.

Referenced by ns3::LteRlcSpecificLteMacSapUser::ReceivePdu().

+ Here is the caller graph for this function:

virtual void ns3::LteRlc::DoTransmitPdcpPdu ( Ptr< Packet >  p)
protectedpure virtual
Todo:
MRE What is the sense to duplicate all the interfaces here???

Implemented in ns3::LteRlcSm, ns3::LteRlcAm, ns3::LteRlcTm, and ns3::LteRlcUm.

LteMacSapUser * ns3::LteRlc::GetLteMacSapUser ( )
Returns
the MAC SAP User interface offered to the MAC by this LTE_RLC

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

References m_macSapUser, and NS_LOG_FUNCTION.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteUeRrc::DoInitialize(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

LteRlcSapProvider * ns3::LteRlc::GetLteRlcSapProvider ( )
Returns
the RLC SAP Provider interface offered to the PDCP by this LTE_RLC

Definition at line 146 of file lte-rlc.cc.

References m_rlcSapProvider, and NS_LOG_FUNCTION.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

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

Definition at line 102 of file lte-rlc.cc.

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

+ Here is the call graph for this function:

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

Definition at line 132 of file lte-rlc.cc.

References m_lcid, and NS_LOG_FUNCTION.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteUeRrc::DoInitialize(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

void ns3::LteRlc::SetLteMacSapProvider ( LteMacSapProvider *  s)
Parameters
sthe MAC SAP Provider to be used by this LTE_RLC

Definition at line 153 of file lte-rlc.cc.

References m_macSapProvider, NS_LOG_FUNCTION, and s.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteUeRrc::DoInitialize(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

void ns3::LteRlc::SetLteRlcSapUser ( LteRlcSapUser *  s)
Parameters
sthe RLC SAP user to be used by this LTE_RLC

Definition at line 139 of file lte-rlc.cc.

References m_rlcSapUser, NS_LOG_FUNCTION, and s.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

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

Definition at line 125 of file lte-rlc.cc.

References m_rnti, and NS_LOG_FUNCTION.

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::UeManager::DoInitialize(), ns3::LteUeRrc::DoInitialize(), LteRlcUmTransmitterTestCase::DoRun(), LteRlcAmTransmitterTestCase::DoRun(), ns3::LteSimpleHelper::InstallSingleEnbDevice(), ns3::LteSimpleHelper::InstallSingleUeDevice(), and ns3::UeManager::SetupDataRadioBearer().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class LteRlcSpecificLteMacSapUser
friend

Definition at line 52 of file lte-rlc.h.

Referenced by LteRlc().

friend class LteRlcSpecificLteRlcSapProvider< LteRlc >
friend

Definition at line 53 of file lte-rlc.h.

Member Data Documentation

uint8_t ns3::LteRlc::m_lcid
protected

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

Referenced by ns3::LteRlcTm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteRlcSm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcTm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), ns3::LteRlcTm::DoReportBufferStatus(), ns3::LteRlcUm::DoReportBufferStatus(), ns3::LteRlcAm::DoReportBufferStatus(), ns3::LteRlcUm::DoTransmitPdcpPdu(), ns3::LteRlcTm::DoTransmitPdcpPdu(), ns3::LteRlcAm::DoTransmitPdcpPdu(), ns3::LteRlcUm::ExpireReorderingTimer(), ns3::LteRlcSm::ReportBufferStatus(), and SetLcId().

LteMacSapProvider* ns3::LteRlc::m_macSapProvider
protected

Definition at line 120 of file lte-rlc.h.

Referenced by ns3::LteRlcTm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteRlcSm::DoNotifyTxOpportunity(), ns3::LteRlcTm::DoReportBufferStatus(), ns3::LteRlcUm::DoReportBufferStatus(), ns3::LteRlcAm::DoReportBufferStatus(), ns3::LteRlcSm::ReportBufferStatus(), and SetLteMacSapProvider().

LteMacSapUser* ns3::LteRlc::m_macSapUser
protected

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

Referenced by DoDispose(), GetLteMacSapUser(), and LteRlc().

LteRlcSapProvider* ns3::LteRlc::m_rlcSapProvider
protected

Definition at line 112 of file lte-rlc.h.

Referenced by DoDispose(), GetLteRlcSapProvider(), and LteRlc().

LteRlcSapUser* ns3::LteRlc::m_rlcSapUser
protected

Definition at line 111 of file lte-rlc.h.

Referenced by ns3::LteRlcTm::DoReceivePdu(), ns3::LteRlcUm::ReassembleAndDeliver(), ns3::LteRlcAm::ReassembleAndDeliver(), and SetLteRlcSapUser().

uint16_t ns3::LteRlc::m_rnti
protected

Definition at line 122 of file lte-rlc.h.

Referenced by ns3::LteRlcTm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteRlcSm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcTm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), ns3::LteRlcTm::DoReportBufferStatus(), ns3::LteRlcUm::DoReportBufferStatus(), ns3::LteRlcAm::DoReportBufferStatus(), ns3::LteRlcUm::DoTransmitPdcpPdu(), ns3::LteRlcTm::DoTransmitPdcpPdu(), ns3::LteRlcAm::DoTransmitPdcpPdu(), ns3::LteRlcUm::ExpireReorderingTimer(), ns3::LteRlcSm::ReportBufferStatus(), and SetRnti().

TracedCallback<uint16_t, uint8_t, uint32_t, uint64_t> ns3::LteRlc::m_rxPdu
protected

Used to inform of a PDU reception from the MAC SAP user.

Definition at line 132 of file lte-rlc.h.

Referenced by ns3::LteRlcTm::DoReceivePdu(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), and GetTypeId().

TracedCallback<uint16_t, uint8_t, uint32_t> ns3::LteRlc::m_txPdu
protected

Used to inform of a PDU delivery to the MAC SAP provider.

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

Referenced by ns3::LteRlcTm::DoNotifyTxOpportunity(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteRlcSm::DoNotifyTxOpportunity(), and GetTypeId().

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