#include <lte-rlc-am.h>

Inheritance diagram for ns3::LteRlcAm:

Collaboration diagram for ns3::LteRlcAm:

Classes
struct	PduBuffer
struct	RetxBuffer

Public Member Functions
	LteRlcAm ()
virtual	~LteRlcAm ()
virtual void	DoNotifyHarqDeliveryFailure ()
virtual void	DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer)
virtual void	DoReceivePdu (Ptr< Packet > p)
virtual void	DoTransmitPdcpPdu (Ptr< Packet > p)
void	Start ()
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 ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)

Private Types
enum	ReassemblingState_t { NONE = 0, WAITING_S0_FULL = 1, WAITING_SI_SF = 2 }

Private Member Functions
void	ExpirePollRetransmitTimer (void)
void	ExpireReorderingTimer (void)
bool	IsInsideReceivingWindow (SequenceNumber10 seqNumber)
void	ReassembleAndDeliver (Ptr< Packet > packet)

Private Attributes
uint32_t	m_byteWithoutPoll
Ptr< Packet >	m_controlPduBuffer
SequenceNumber10	m_expectedSeqNumber
Ptr< Packet >	m_keepS0
uint16_t	m_maxRetxThreshold
uint32_t	m_pduWithoutPoll
uint16_t	m_pollByte
uint16_t	m_pollPdu
EventId	m_pollRetransmitTimer
SequenceNumber10	m_pollSn
ReassemblingState_t	m_reassemblingState
EventId	m_reorderingTimer
std::vector< RetxBuffer >	m_retxBuffer
uint32_t	m_retxBufferSize
std::map< uint16_t, PduBuffer >	m_rxonBuffer
std::list< Ptr< Packet > >	m_sdusBuffer
uint32_t	m_statusPduBufferSize
bool	m_statusPduRequested
EventId	m_statusProhibitTimer
std::vector< Ptr< Packet > >	m_txedBuffer
uint32_t	m_txedBufferSize
std::vector< Ptr< Packet > >	m_txonBuffer
uint32_t	m_txonBufferSize
SequenceNumber10	m_vrH
SequenceNumber10	m_vrMr
SequenceNumber10	m_vrMs
SequenceNumber10	m_vrR
SequenceNumber10	m_vrX
SequenceNumber10	m_vtA
SequenceNumber10	m_vtMs
SequenceNumber10	m_vtS
uint16_t	m_windowSize

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)
Protected Attributes inherited from ns3::LteRlc
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
TracedCallback< uint16_t, uint8_t, uint32_t >	m_txPdu

Detailed Description

LTE RLC Acknowledged Mode (AM), see 3GPP TS 36.322

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/RadioBearerMap/[i]/LteRlc/$ns3::LteRlcAm
/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/RadioBearerMap/[i]/LteRlc/$ns3::LteRlcAm
/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/RadioBearerMap/[i]/LteRlc/$ns3::LteRlcAm
/NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/RadioBearerMap/[i]/LteRlc/$ns3::LteRlcAm

No Attributes are defined for this type.
No TraceSources are defined for this type.

TraceSources defined in parent class ns3::LteRlc

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

Definition at line 36 of file lte-rlc-am.h.

Member Enumeration Documentation

enum ns3::LteRlcAm::ReassemblingState_t

private

SDU Reassembling state

Enumerator:

NONE
WAITING_S0_FULL
WAITING_SI_SF

Definition at line 155 of file lte-rlc-am.h.

Constructor & Destructor Documentation

ns3::LteRlcAm::LteRlcAm ( )

Definition at line 35 of file lte-rlc-am.cc.

References m_byteWithoutPoll, m_expectedSeqNumber, m_maxRetxThreshold, m_pduWithoutPoll, m_pollByte, m_pollPdu, m_pollSn, m_reassemblingState, m_retxBuffer, m_retxBufferSize, m_statusPduBufferSize, m_statusPduRequested, m_txedBuffer, m_txedBufferSize, m_txonBufferSize, m_vrH, m_vrMr, m_vrMs, m_vrR, m_vrX, m_vtA, m_vtMs, m_vtS, m_windowSize, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), Start(), and WAITING_S0_FULL.

Here is the call graph for this function:

ns3::LteRlcAm::~LteRlcAm ( )

virtual

Definition at line 79 of file lte-rlc-am.cc.

Member Function Documentation

void ns3::LteRlcAm::DoNotifyHarqDeliveryFailure ( )

virtual

Implements ns3::LteRlc.

Definition at line 547 of file lte-rlc-am.cc.

References NS_LOG_FUNCTION.

void ns3::LteRlcAm::DoNotifyTxOpportunity	(	uint32_t	bytes,
		uint8_t	layer
	)

virtual

MAC SAP

Implements ns3::LteRlc.

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

Here is the call graph for this function:

void ns3::LteRlcAm::DoReceivePdu ( Ptr< Packet > p )

virtual

Implements ns3::LteRlc.

Definition at line 553 of file lte-rlc-am.cc.

References ns3::EventId::Cancel(), ExpireReorderingTimer(), ns3::Packet::FindFirstMatchingByteTag(), ns3::Time::GetMilliSeconds(), ns3::Time::GetNanoSeconds(), ns3::RlcTag::GetSenderTimestamp(), ns3::Packet::GetSize(), ns3::SequenceNumber10::GetValue(), IsInsideReceivingWindow(), ns3::EventId::IsRunning(), ns3::LteMacSapProvider::ReportBufferStatusParameters::lcid, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_maxRetxThreshold, m_reorderingTimer, m_retxBuffer, m_retxBufferSize, ns3::LteRlc::m_rnti, m_rxonBuffer, ns3::LteRlc::m_rxPdu, m_statusPduBufferSize, m_statusPduRequested, m_statusProhibitTimer, m_txedBuffer, m_txedBufferSize, m_txonBuffer, m_txonBufferSize, m_vrH, m_vrMr, m_vrMs, m_vrR, m_vrX, m_vtA, m_vtS, m_windowSize, ns3::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, NS_LOG_WARN, ns3::LteRlcAmHeader::PDU, ns3::Packet::PeekHeader(), ReassembleAndDeliver(), ns3::LteMacSapProvider::ReportBufferStatus(), ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueHolDelay, ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::rnti, ns3::Simulator::Schedule(), ns3::LteRlcAmHeader::SEGMENT, ns3::LteRlcAmHeader::STATUS_REPORT_IS_REQUESTED, ns3::LteMacSapProvider::ReportBufferStatusParameters::statusPduSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueHolDelay, and ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueSize.

Here is the call graph for this function:

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

virtual

RLC SAP

Store arrival time

Store PDCP PDU

Report Buffer Status

Implements ns3::LteRlc.

Definition at line 99 of file lte-rlc-am.cc.

Here is the call graph for this function:

void ns3::LteRlcAm::ExpirePollRetransmitTimer ( void )

private

Definition at line 1556 of file lte-rlc-am.cc.

References NS_LOG_LOGIC.

Referenced by DoNotifyTxOpportunity().

Here is the caller graph for this function:

void ns3::LteRlcAm::ExpireReorderingTimer ( void )

private

This method will schedule a timeout at WaitReplyTimeout interval in the future, unless a timer is already running for the cache, in which case this method does nothing.

Definition at line 1520 of file lte-rlc-am.cc.

References ns3::SequenceNumber10::GetValue(), m_reorderingTimer, m_rxonBuffer, m_vrH, m_vrMs, m_vrX, NS_ASSERT_MSG, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Referenced by DoReceivePdu().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::LteRlcAm::GetTypeId ( void )

static

Reimplemented from ns3::LteRlc.

Definition at line 84 of file lte-rlc-am.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::LteRlcAm::IsInsideReceivingWindow ( SequenceNumber10 seqNumber )

private

Definition at line 1025 of file lte-rlc-am.cc.

References m_vrMr, m_vrR, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SequenceNumber10::SetModulusBase().

Referenced by DoReceivePdu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LteRlcAm::ReassembleAndDeliver ( Ptr< Packet > packet )

private

Deliver one or multiple PDUs

Deliver full PDUs

Keep S0

ERROR: Transition not possible

Deliver (Kept)S0 + SN

Deliver zero, one or multiple PDUs

Keep SI

Deliver (Kept)S0 + SN

Deliver zero, one or multiple PDUs

Keep S0

ERROR: Transition not possible

Deliver one or multiple PDUs

Deliver full PDUs

Keep S0

Discard SN

Deliver zero, one or multiple PDUs

Discard SI or SN

Deliver zero, one or multiple PDUs

Keep S0

ERROR: Transition not possible

Discard S0

Deliver one or multiple PDUs

Discard S0

Deliver zero, one or multiple PDUs

Keep S0

Discard S0

Discard SI or SN

Deliver zero, one or multiple PDUs

Discard S0

Discard SI or SN

Deliver zero, one or multiple PDUs

Keep S0

ERROR: Transition not possible

Definition at line 1049 of file lte-rlc-am.cc.

Referenced by DoReceivePdu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LteRlcAm::Start ( void )

This method calls the virtual DoStart method on all the objects aggregated to this object. DoStart will be called only once over the lifetime of an object, just like DoDispose is called only once.

See Also: DoStart

Note: the code here is a bit tricky because we need to protect ourselves from modifications in the aggregate array while DoStart is called. The user's implementation of the DoStart method could call GetObject (which could reorder the array) and it could call AggregateObject which would add an object at the end of the array. To be safe, we restart iteration over the array whenever we call some user code, just in case.

Reimplemented from ns3::Object.

Definition at line 1007 of file lte-rlc-am.cc.