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

LTE RLC Transparent Mode (TM), see 3GPP TS 36.322. More...

#include "lte-rlc-tm.h"

+ Inheritance diagram for ns3::LteRlcTm:
+ Collaboration diagram for ns3::LteRlcTm:

Classes

struct  TxPdu
 Store an incoming (from layer above us) PDU, waiting to transmit it. More...
 

Public Member Functions

 LteRlcTm ()
 
virtual ~LteRlcTm ()
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoNotifyHarqDeliveryFailure ()
 Notify HARQ deliver failure. More...
 
virtual void DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters txOpParams)
 MAC SAP. More...
 
virtual void DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams)
 Receive PDU function. More...
 
virtual void DoTransmitPdcpPdu (Ptr< Packet > p)
 RLC SAP. More...
 
- Public Member Functions inherited from ns3::LteRlc
 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<>
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::LteRlc
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...
 

Private Member Functions

void DoReportBufferStatus ()
 Report buffer status. More...
 
void ExpireRbsTimer (void)
 Expire RBS timer function. More...
 

Private Attributes

uint32_t m_maxTxBufferSize
 maximum transmit buffer size More...
 
EventId m_rbsTimer
 RBS timer. More...
 
std::vector< TxPdum_txBuffer
 Transmission buffer. More...
 
uint32_t m_txBufferSize
 transmit buffer size More...
 

Additional Inherited Members

- Public Types inherited from ns3::LteRlc
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...
 
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 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 inherited from ns3::LteRlc
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< Ptr< const Packet > > m_txDropTrace
 The trace source fired when the RLC drops a packet before transmission. More...
 
TracedCallback< uint16_t, uint8_t, uint32_tm_txPdu
 Used to inform of a PDU delivery to the MAC SAP provider. More...
 

Detailed Description

LTE RLC Transparent Mode (TM), see 3GPP TS 36.322.

Please note that, as in TM it is not possible to add any header, the delay measurements gathered from the trace source "RxPDU" of LteRlc are invalid (they will be always 0)

Config Paths

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

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

Attributes

  • MaxTxBufferSize: Maximum Size of the Transmission Buffer (in Bytes)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 2097152
    • Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::LteRlc

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

Definition at line 39 of file lte-rlc-tm.h.

Constructor & Destructor Documentation

◆ LteRlcTm()

ns3::LteRlcTm::LteRlcTm ( )

Definition at line 33 of file lte-rlc-tm.cc.

References NS_LOG_FUNCTION.

◆ ~LteRlcTm()

ns3::LteRlcTm::~LteRlcTm ( )
virtual

Definition at line 40 of file lte-rlc-tm.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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

Definition at line 62 of file lte-rlc-tm.cc.

References ns3::EventId::Cancel(), ns3::LteRlc::DoDispose(), m_rbsTimer, m_txBuffer, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoNotifyHarqDeliveryFailure()

void ns3::LteRlcTm::DoNotifyHarqDeliveryFailure ( )
virtual

Notify HARQ deliver failure.

Implements ns3::LteRlc.

Definition at line 158 of file lte-rlc-tm.cc.

References NS_LOG_FUNCTION.

◆ DoNotifyTxOpportunity()

◆ DoReceivePdu()

void ns3::LteRlcTm::DoReceivePdu ( LteMacSapUser::ReceivePduParameters  params)
virtual

◆ DoReportBufferStatus()

◆ DoTransmitPdcpPdu()

void ns3::LteRlcTm::DoTransmitPdcpPdu ( Ptr< Packet p)
virtual

RLC SAP.

Parameters
ppacket

Report Buffer Status

Implements ns3::LteRlc.

Definition at line 77 of file lte-rlc-tm.cc.

References ns3::EventId::Cancel(), DoReportBufferStatus(), ns3::Packet::GetSize(), ns3::LteRlc::m_lcid, m_maxTxBufferSize, m_rbsTimer, ns3::LteRlc::m_rnti, m_txBuffer, m_txBufferSize, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ ExpireRbsTimer()

void ns3::LteRlcTm::ExpireRbsTimer ( void  )
private

Expire RBS timer function.

Definition at line 206 of file lte-rlc-tm.cc.

References DoReportBufferStatus(), ExpireRbsTimer(), m_rbsTimer, m_txBuffer, ns3::MilliSeconds(), NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Referenced by DoNotifyTxOpportunity(), and ExpireRbsTimer().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 46 of file lte-rlc-tm.cc.

References m_maxTxBufferSize, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_maxTxBufferSize

uint32_t ns3::LteRlcTm::m_maxTxBufferSize
private

maximum transmit buffer size

Definition at line 100 of file lte-rlc-tm.h.

Referenced by DoTransmitPdcpPdu(), and GetTypeId().

◆ m_rbsTimer

EventId ns3::LteRlcTm::m_rbsTimer
private

RBS timer.

Definition at line 103 of file lte-rlc-tm.h.

Referenced by DoDispose(), DoNotifyTxOpportunity(), DoTransmitPdcpPdu(), and ExpireRbsTimer().

◆ m_txBuffer

std::vector< TxPdu > ns3::LteRlcTm::m_txBuffer
private

Transmission buffer.

Definition at line 98 of file lte-rlc-tm.h.

Referenced by DoDispose(), DoNotifyTxOpportunity(), DoReportBufferStatus(), DoTransmitPdcpPdu(), and ExpireRbsTimer().

◆ m_txBufferSize

uint32_t ns3::LteRlcTm::m_txBufferSize
private

transmit buffer size

Definition at line 101 of file lte-rlc-tm.h.

Referenced by DoNotifyTxOpportunity(), DoReportBufferStatus(), and DoTransmitPdcpPdu().


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