A Discrete-Event Network Simulator
API
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 Types

typedef void(* NotifyTxTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes)
 TracedCallback signature for NotifyTxOpportunity events. More...
 
typedef void(* ReceiveTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes, uint64_t delay)
 TracedCallback signature for. More...
 

Public Member Functions

 LteRlc ()
 
virtual ~LteRlc ()
 
virtual void DoDispose ()
 Destructor implementation. More...
 
LteMacSapUserGetLteMacSapUser ()
 
LteRlcSapProviderGetLteRlcSapProvider ()
 
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 ()
 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<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 by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::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...
 
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...
 

Protected Member Functions

virtual void DoNotifyHarqDeliveryFailure ()=0
 Notify HARQ delivery failure. More...
 
virtual void DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters params)=0
 Notify transmit opportunity. More...
 
virtual void DoReceivePdu (LteMacSapUser::ReceivePduParameters params)=0
 Receive PDU function. More...
 
virtual void DoTransmitPdcpPdu (Ptr< Packet > p)=0
 Transmit PDCP PDU. More...
 
- 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
 LCID. More...
 
LteMacSapProviderm_macSapProvider
 MAC SAP provider. More...
 
LteMacSapUserm_macSapUser
 MAC 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 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
 allow LteRlcSpecificLteMacSapUser class friend access More...
 
class LteRlcSpecificLteRlcSapProvider< LteRlc >
 allow LteRlcSpecificLteRlcSapProvider<LteRlc> class friend access More...
 

Additional Inherited Members

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

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

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

Member Typedef Documentation

◆ NotifyTxTracedCallback

typedef void(* ns3::LteRlc::NotifyTxTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes)

TracedCallback signature for NotifyTxOpportunity events.

Parameters
[in]rntiC-RNTI scheduled.
[in]lcidThe logical channel id corresponding to the sending RLC instance.
[in]bytesThe number of bytes to transmit

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

◆ ReceiveTracedCallback

typedef void(* ns3::LteRlc::ReceiveTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes, uint64_t delay)

TracedCallback signature for.

Parameters
[in]rntiC-RNTI scheduled.
[in]lcidThe logical channel id corresponding to the sending RLC instance.
[in]bytesThe packet size.
[in]delayDelay since sender timestamp, in ns.

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

Constructor & Destructor Documentation

◆ LteRlc()

ns3::LteRlc::LteRlc ( )

◆ ~LteRlc()

ns3::LteRlc::~LteRlc ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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

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

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

References m_macSapUser, m_rlcSapProvider, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ DoNotifyHarqDeliveryFailure()

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

Notify HARQ delivery failure.

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

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

+ Here is the caller graph for this function:

◆ DoNotifyTxOpportunity()

virtual void ns3::LteRlc::DoNotifyTxOpportunity ( LteMacSapUser::TxOpportunityParameters  params)
protectedpure virtual

Notify transmit opportunity.

Parameters
paramsLteMacSapUser::TxOpportunityParameters

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

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

+ Here is the caller graph for this function:

◆ DoReceivePdu()

virtual void ns3::LteRlc::DoReceivePdu ( LteMacSapUser::ReceivePduParameters  params)
protectedpure virtual

Receive PDU function.

Parameters
paramsthe LteMacSapUser::ReceivePduParameters

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

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

+ Here is the caller graph for this function:

◆ DoTransmitPdcpPdu()

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

Transmit PDCP PDU.

Todo:
MRE What is the sense to duplicate all the interfaces here???
Parameters
ppacket

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

◆ GetLteMacSapUser()

◆ GetLteRlcSapProvider()

LteRlcSapProvider * ns3::LteRlc::GetLteRlcSapProvider ( )

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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:

◆ SetLcId()

◆ SetLteMacSapProvider()

◆ SetLteRlcSapUser()

void ns3::LteRlc::SetLteRlcSapUser ( LteRlcSapUser s)

◆ SetRnti()

Friends And Related Function Documentation

◆ LteRlcSpecificLteMacSapUser

friend class LteRlcSpecificLteMacSapUser
friend

allow LteRlcSpecificLteMacSapUser class friend access

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

Referenced by LteRlc().

◆ LteRlcSpecificLteRlcSapProvider< LteRlc >

friend class LteRlcSpecificLteRlcSapProvider< LteRlc >
friend

allow LteRlcSpecificLteRlcSapProvider<LteRlc> class friend access

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

Member Data Documentation

◆ m_lcid

◆ m_macSapProvider

◆ m_macSapUser

LteMacSapUser* ns3::LteRlc::m_macSapUser
protected

MAC SAP user.

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

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

◆ m_rlcSapProvider

LteRlcSapProvider* ns3::LteRlc::m_rlcSapProvider
protected

RLC SAP provider.

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

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

◆ m_rlcSapUser

LteRlcSapUser* ns3::LteRlc::m_rlcSapUser
protected

◆ m_rnti

◆ m_rxPdu

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 178 of file lte-rlc.h.

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

◆ m_txPdu

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 174 of file lte-rlc.h.

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


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