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

#include "lte-rlc-tm.h"

Inheritance diagram for ns3::LteRlcTm:

Public Member Functions
	LteRlcTm ()

virtual	~LteRlcTm ()

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoNotifyHarqDeliveryFailure ()
	Notify HARQ deliver failure. More...

virtual void	DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId, uint8_t componentCarrierId, uint16_t rnti, uint8_t lcid)
	MAC SAP. More...

virtual void	DoReceivePdu (Ptr< Packet > p, uint16_t rnti, uint8_t lcid)
	Receive PDU function. More...

virtual void	DoTransmitPdcpPdu (Ptr< Packet > p)
	RLC SAP. More...

Public Member Functions inherited from ns3::LteRlc
	LteRlc ()

virtual	~LteRlc ()

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 ()
	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...

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

SimpleRefCount &	operator= (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::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< Ptr< Packet > >	m_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...

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 inherited from ns3::LteRlc
uint8_t	m_lcid
	LCID. More...

LteMacSapProvider *	m_macSapProvider
	MAC SAP provider. More...

LteMacSapUser *	m_macSapUser
	MAC SAP user. More...

LteRlcSapProvider *	m_rlcSapProvider
	RLC SAP provider. More...

LteRlcSapUser *	m_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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

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

Config Paths

ns3::LteRlcTm 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/$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::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::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

TxPDU: PDU transmission notified to the MAC.
Callback signature: ns3::LteRlc::NotifyTxTracedCallback
RxPDU: PDU received.
Callback signature: ns3::LteRlc::ReceiveTracedCallback

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

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

Constructor & Destructor Documentation

◆ LteRlcTm()

ns3::LteRlcTm::LteRlcTm ( )

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

References NS_LOG_FUNCTION.

◆ ~LteRlcTm()

ns3::LteRlcTm::~LteRlcTm ( )

virtual

Definition at line 41 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 63 of file lte-rlc-tm.cc.

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

◆ DoNotifyHarqDeliveryFailure()

void ns3::LteRlcTm::DoNotifyHarqDeliveryFailure ( )

virtual

Notify HARQ deliver failure.

Implements ns3::LteRlc.

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

References NS_LOG_FUNCTION.

◆ DoNotifyTxOpportunity()

void ns3::LteRlcTm::DoNotifyTxOpportunity	(	uint32_t	bytes,
		uint8_t	layer,
		uint8_t	harqId,
		uint8_t	componentCarrierId,
		uint16_t	rnti,
		uint8_t	lcid
	)

virtual

MAC SAP.

Parameters

bytes	number of bytes
layer	the layer
harqId	HARQ ID
componentCarrierId	component carrier ID
rnti	the RNTI
lcid	the LCID

Implements ns3::LteRlc.

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

References ns3::EventId::Cancel(), ns3::Packet::Copy(), ExpireRbsTimer(), ns3::GetSize(), ns3::Packet::GetSize(), ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_rbsTimer, ns3::LteRlc::m_rnti, m_txBuffer, m_txBufferSize, ns3::LteRlc::m_txPdu, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), NS_LOG_WARN, ns3::LteMacSapProvider::TransmitPduParameters::pdu, ns3::Packet::ReplacePacketTag(), ns3::Simulator::Schedule(), and ns3::LteMacSapProvider::TransmitPdu().

◆ DoReceivePdu()

void ns3::LteRlcTm::DoReceivePdu	(	Ptr< Packet >	p,
		uint16_t	rnti,
		uint8_t	lcid
	)

virtual

Receive PDU function.

Parameters

p	the packet
rnti	the RNTI
lcid	the LCID

Implements ns3::LteRlc.

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

References ns3::Time::GetNanoSeconds(), ns3::Packet::GetSize(), ns3::LteRlc::m_lcid, ns3::LteRlc::m_rlcSapUser, ns3::LteRlc::m_rnti, ns3::LteRlc::m_rxPdu, ns3::Simulator::Now(), NS_ASSERT_MSG(), NS_LOG_FUNCTION, ns3::Packet::PeekPacketTag(), ns3::LteRlcSapUser::ReceivePdcpPdu(), and ns3::Packet::RemovePacketTag().

◆ DoReportBufferStatus()

void ns3::LteRlcTm::DoReportBufferStatus ( void )

private

Report buffer status.

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

Referenced by DoTransmitPdcpPdu(), and ExpireRbsTimer().

◆ DoTransmitPdcpPdu()

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

virtual

RLC SAP.

Parameters

p packet

Store arrival time
Report Buffer Status

Implements ns3::LteRlc.

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

References ns3::Packet::AddPacketTag(), 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().

◆ ExpireRbsTimer()

void ns3::LteRlcTm::ExpireRbsTimer ( void )

private

Expire RBS timer function.

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

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

Referenced by DoNotifyTxOpportunity().

◆ GetTypeId()

TypeId ns3::LteRlcTm::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

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

Member Data Documentation

◆ m_maxTxBufferSize

uint32_t ns3::LteRlcTm::m_maxTxBufferSize

private

maximum transmit buffer size

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

Referenced by DoTransmitPdcpPdu(), and GetTypeId().

◆ m_rbsTimer

EventId ns3::LteRlcTm::m_rbsTimer

private

RBS timer.

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

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

◆ m_txBuffer

std::vector< Ptr<Packet> > ns3::LteRlcTm::m_txBuffer

private

Transmission buffer.

Definition at line 80 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 79 of file lte-rlc-tm.h.

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

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

src/lte/model/lte-rlc-tm.h
src/lte/model/lte-rlc-tm.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources defined in parent class ns3::LteRlc

Constructor & Destructor Documentation

◆ LteRlcTm()

◆ ~LteRlcTm()

Member Function Documentation

◆ DoDispose()

◆ DoNotifyHarqDeliveryFailure()

◆ DoNotifyTxOpportunity()

◆ DoReceivePdu()

◆ DoReportBufferStatus()

◆ DoTransmitPdcpPdu()

◆ ExpireRbsTimer()

◆ GetTypeId()

Member Data Documentation

◆ m_maxTxBufferSize

◆ m_rbsTimer

◆ m_txBuffer

◆ m_txBufferSize