A Discrete-Event Network Simulator
API
Classes | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::LteRlcAm Class Reference

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

#include "lte-rlc-am.h"

+ Inheritance diagram for ns3::LteRlcAm:
+ Collaboration diagram for ns3::LteRlcAm:

Classes

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

Public Member Functions

 LteRlcAm ()
 
 ~LteRlcAm () override
 
void DoDispose () override
 Destructor implementation. More...
 
void DoNotifyHarqDeliveryFailure () override
 Notify HARQ delivery failure. More...
 
void DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters txOpParams) override
 MAC SAP. More...
 
void DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams) override
 Receive PDU function. More...
 
void DoTransmitPdcpPdu (Ptr< Packet > p) override
 RLC SAP. More...
 
- Public Member Functions inherited from ns3::LteRlc
 LteRlc ()
 
 ~LteRlc () override
 
void DoDispose () override
 Destructor implementation. More...
 
LteMacSapUser * GetLteMacSapUser ()
 
LteRlcSapProvider * GetLteRlcSapProvider ()
 
void SetLcId (uint8_t lcId)
 
void SetLteMacSapProvider (LteMacSapProvider *s)
 
void SetLteRlcSapUser (LteRlcSapUser *s)
 
void SetPacketDelayBudgetMs (uint16_t packetDelayBudget)
 
void SetRnti (uint16_t rnti)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< Object > GetObject () 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< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::LteRlc
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Types

enum  ReassemblingState_t { NONE = 0 , WAITING_S0_FULL = 1 , WAITING_SI_SF = 2 }
 SDU Reassembling state. More...
 

Private Member Functions

void DoReportBufferStatus ()
 Report buffer status. More...
 
void ExpirePollRetransmitTimer ()
 Expire poll retransmitter. More...
 
void ExpireRbsTimer ()
 Expire RBS timer. More...
 
void ExpireReorderingTimer ()
 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. More...
 
void ExpireStatusProhibitTimer ()
 method called when the T_status_prohibit timer expires More...
 
bool IsInsideReceivingWindow (SequenceNumber10 seqNumber)
 method called when the T_status_prohibit timer expires More...
 
void ReassembleAndDeliver (Ptr< Packet > packet)
 Reassemble and deliver. More...
 

Private Attributes

uint32_t m_byteWithoutPoll
 byte without poll More...
 
Ptr< Packet > m_controlPduBuffer
 Control PDU buffer (just one PDU) More...
 
SequenceNumber10 m_expectedSeqNumber
 Expected Sequence Number. More...
 
Ptr< Packet > m_keepS0
 keep S0 More...
 
uint16_t m_maxRetxThreshold
 Configurable parameters. More...
 
uint32_t m_maxTxBufferSize
 maximum transmission buffer size More...
 
uint32_t m_pduWithoutPoll
 Counters. More...
 
uint16_t m_pollByte
 poll byte More...
 
uint16_t m_pollPdu
 poll PDU More...
 
EventId m_pollRetransmitTimer
 Timers. More...
 
bool m_pollRetransmitTimerJustExpired
 poll retransmit timer just expired? More...
 
Time m_pollRetransmitTimerValue
 poll retransmit time value More...
 
SequenceNumber10 m_pollSn
 POLL_SN. More...
 
EventId m_rbsTimer
 RBS timer. More...
 
Time m_rbsTimerValue
 RBS timer value. More...
 
ReassemblingState_t m_reassemblingState
 reassembling state More...
 
EventId m_reorderingTimer
 reordering timer More...
 
Time m_reorderingTimerValue
 reordering timer value More...
 
std::vector< RetxPdu > m_retxBuffer
 Buffer for PDUs considered for retransmission. More...
 
uint32_t m_retxBufferSize
 retransmit buffer size More...
 
std::map< uint16_t, PduBuffer > m_rxonBuffer
 Reception buffer. More...
 
std::list< Ptr< Packet > > m_sdusBuffer
 List of SDUs in a packet (PDU) More...
 
uint32_t m_statusPduBufferSize
 status PDU buffer size More...
 
bool m_statusPduRequested
 status PDU requested More...
 
EventId m_statusProhibitTimer
 status prohibit timer More...
 
Time m_statusProhibitTimerValue
 status prohibit timer value More...
 
std::vector< RetxPdu > m_txedBuffer
 Buffer for transmitted and retransmitted PDUs that have not been acked but are not considered for retransmission. More...
 
uint32_t m_txedBufferSize
 transmit ed buffer size More...
 
std::vector< TxPdu > m_txonBuffer
 Transmission buffer. More...
 
uint32_t m_txonBufferSize
 transmit on buffer size More...
 
bool m_txOpportunityForRetxAlwaysBigEnough
 transmit opportunity for retransmit? More...
 
SequenceNumber10 m_vrH
 VR(H) More...
 
SequenceNumber10 m_vrMr
 VR(MR) More...
 
SequenceNumber10 m_vrMs
 VR(MS) More...
 
SequenceNumber10 m_vrR
 VR(R) More...
 
SequenceNumber10 m_vrX
 VR(X) More...
 
SequenceNumber10 m_vtA
 State variables. More...
 
SequenceNumber10 m_vtMs
 VT(MS) More...
 
SequenceNumber10 m_vtS
 VT(S) More...
 
uint16_t m_windowSize
 Constants. 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 ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 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...
 
uint16_t m_packetDelayBudgetMs
 the packet delay budget in ms of the corresponding logical channel 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< Ptr< const Packet > > m_txDropTrace
 The trace source fired when the RLC drops a packet before transmission. 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 ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

Detailed Description

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

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

Member Enumeration Documentation

◆ ReassemblingState_t

enum ns3::LteRlcAm::ReassemblingState_t
private

SDU Reassembling state.

Enumerator
NONE 
WAITING_S0_FULL 
WAITING_SI_SF 

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

Constructor & Destructor Documentation

◆ LteRlcAm()

ns3::LteRlcAm::LteRlcAm ( )

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

References m_byteWithoutPoll, m_expectedSeqNumber, m_maxRetxThreshold, m_pduWithoutPoll, m_pollByte, m_pollPdu, m_pollRetransmitTimerJustExpired, 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, and WAITING_S0_FULL.

◆ ~LteRlcAm()

ns3::LteRlcAm::~LteRlcAm ( )
override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteRlcAm::DoDispose ( void  )
overridevirtual

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.

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

References ns3::EventId::Cancel(), ns3::LteRlc::DoDispose(), m_controlPduBuffer, m_keepS0, m_maxTxBufferSize, m_pollRetransmitTimer, m_rbsTimer, m_reorderingTimer, m_retxBuffer, m_retxBufferSize, m_rxonBuffer, m_sdusBuffer, m_statusProhibitTimer, m_txedBuffer, m_txedBufferSize, m_txonBuffer, m_txonBufferSize, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoNotifyHarqDeliveryFailure()

void ns3::LteRlcAm::DoNotifyHarqDeliveryFailure ( )
overridevirtual

Notify HARQ delivery failure.

Implements ns3::LteRlc.

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

References NS_LOG_FUNCTION.

◆ DoNotifyTxOpportunity()

void ns3::LteRlcAm::DoNotifyTxOpportunity ( LteMacSapUser::TxOpportunityParameters  txOpParams)
overridevirtual

MAC SAP.

Parameters
txOpParamsthe LteMacSapUser::TxOpportunityParameters

Implements ns3::LteRlc.

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

References ns3::Packet::AddAtEnd(), ns3::Packet::AddByteTag(), ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::LteMacSapUser::TxOpportunityParameters::bytes, ns3::EventId::Cancel(), ns3::LteMacSapUser::TxOpportunityParameters::componentCarrierId, ns3::Packet::Copy(), ns3::Packet::CreateFragment(), ns3::LteRlcAmHeader::DATA_FIELD_FOLLOWS, ns3::LteRlcAmHeader::E_LI_FIELDS_FOLLOWS, ExpirePollRetransmitTimer(), ExpireStatusProhibitTimer(), ns3::LteRlcAmHeader::FIRST_BYTE, ns3::LteRlcSduStatusTag::FIRST_SEGMENT, ns3::LteRlcSduStatusTag::FULL_SDU, ns3::LteRlcAmHeader::GetSequenceNumber(), ns3::LteRlcAmHeader::GetSerializedSize(), ns3::Packet::GetSize(), ns3::LteRlcSduStatusTag::GetStatus(), ns3::SequenceNumber10::GetValue(), ns3::LteMacSapUser::TxOpportunityParameters::harqId, ns3::EventId::IsRunning(), ns3::LteRlcAmHeader::LAST_BYTE, ns3::LteRlcAmHeader::LAST_PDU_SEGMENT, ns3::LteRlcSduStatusTag::LAST_SEGMENT, ns3::LteMacSapUser::TxOpportunityParameters::layer, m_byteWithoutPoll, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_maxRetxThreshold, m_pduWithoutPoll, m_pollByte, m_pollPdu, m_pollRetransmitTimer, m_pollRetransmitTimerJustExpired, m_pollRetransmitTimerValue, m_pollSn, m_retxBuffer, m_retxBufferSize, ns3::LteRlc::m_rnti, m_rxonBuffer, m_statusPduBufferSize, m_statusPduRequested, m_statusProhibitTimer, m_statusProhibitTimerValue, m_txedBuffer, m_txedBufferSize, m_txonBuffer, m_txonBufferSize, m_txOpportunityForRetxAlwaysBigEnough, ns3::LteRlc::m_txPdu, m_vrMs, m_vrR, m_vtA, m_vtMs, m_vtS, ns3::LteRlcSduStatusTag::MIDDLE_SEGMENT, ns3::MilliSeconds(), min, ns3::LteRlcAmHeader::NO_FIRST_BYTE, ns3::LteRlcAmHeader::NO_LAST_BYTE, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::LteRlcAmHeader::OneMoreNackWouldFitIn(), two-ray-to-three-gpp-ch-calibration::params, ns3::LteRlcAmHeader::PDU, ns3::LteRlcAmHeader::PushExtensionBit(), ns3::LteRlcAmHeader::PushLengthIndicator(), ns3::LteRlcAmHeader::PushNack(), ns3::Packet::RemoveAtStart(), ns3::Packet::RemoveHeader(), ns3::Packet::RemovePacketTag(), ns3::Simulator::Schedule(), ns3::LteRlcAmHeader::SetAckSn(), ns3::LteRlcAmHeader::SetControlPdu(), ns3::LteRlcAmHeader::SetDataPdu(), ns3::LteRlcAmHeader::SetFramingInfo(), ns3::LteRlcAmHeader::SetLastSegmentFlag(), ns3::SequenceNumber10::SetModulusBase(), ns3::LteRlcAmHeader::SetPollingBit(), ns3::LteRlcAmHeader::SetResegmentationFlag(), ns3::LteRlcAmHeader::SetSegmentOffset(), ns3::RlcTag::SetSenderTimestamp(), ns3::LteRlcAmHeader::SetSequenceNumber(), ns3::LteRlcSduStatusTag::SetStatus(), ns3::LteRlcAmHeader::STATUS_PDU, ns3::LteRlcAmHeader::STATUS_REPORT_IS_REQUESTED, ns3::LteRlcAmHeader::STATUS_REPORT_NOT_REQUESTED, and ns3::LteMacSapProvider::TransmitPdu().

+ Here is the call graph for this function:

◆ DoReceivePdu()

void ns3::LteRlcAm::DoReceivePdu ( LteMacSapUser::ReceivePduParameters  params)
overridevirtual

Receive PDU function.

Parameters
paramsthe LteMacSapUser::ReceivePduParameters
Todo:
stop and reset the t-Reordering

Implements ns3::LteRlc.

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

References ns3::EventId::Cancel(), DoReportBufferStatus(), ExpireReorderingTimer(), ns3::Packet::FindFirstMatchingByteTag(), ns3::LteRlcAmHeader::GetAckSn(), ns3::Time::GetNanoSeconds(), ns3::LteRlcAmHeader::GetPollingBit(), ns3::LteRlcAmHeader::GetResegmentationFlag(), ns3::RlcTag::GetSenderTimestamp(), ns3::LteRlcAmHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::SequenceNumber10::GetValue(), ns3::LteRlcAmHeader::IsControlPdu(), ns3::LteRlcAmHeader::IsDataPdu(), IsInsideReceivingWindow(), ns3::LteRlcAmHeader::IsNackPresent(), ns3::EventId::IsRunning(), ns3::LteRlc::m_lcid, m_pollRetransmitTimer, m_pollSn, m_reorderingTimer, m_reorderingTimerValue, 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_vrH, m_vrMr, m_vrMs, m_vrR, m_vrX, m_vtA, m_vtMs, m_vtS, m_windowSize, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, NS_LOG_WARN, ns3::LteMacSapUser::ReceivePduParameters::p, ns3::LteRlcAmHeader::PDU, ns3::Packet::PeekHeader(), ReassembleAndDeliver(), ns3::Simulator::Schedule(), ns3::LteRlcAmHeader::SEGMENT, ns3::SequenceNumber10::SetModulusBase(), and ns3::LteRlcAmHeader::STATUS_REPORT_IS_REQUESTED.

+ Here is the call graph for this function:

◆ DoReportBufferStatus()

void ns3::LteRlcAm::DoReportBufferStatus ( )
private

Report buffer status.

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

References ns3::Time::GetMilliSeconds(), ns3::SequenceNumber10::GetValue(), ns3::EventId::IsRunning(), ns3::LteMacSapProvider::ReportBufferStatusParameters::lcid, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_retxBuffer, m_retxBufferSize, ns3::LteRlc::m_rnti, m_statusPduBufferSize, m_statusPduRequested, m_statusProhibitTimer, m_txedBuffer, m_txedBufferSize, m_txonBuffer, m_txonBufferSize, m_vtA, m_vtS, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::LteMacSapProvider::ReportBufferStatus(), ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueHolDelay, ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::rnti, ns3::Seconds(), ns3::LteMacSapProvider::ReportBufferStatusParameters::statusPduSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueHolDelay, and ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueSize.

Referenced by DoReceivePdu(), DoTransmitPdcpPdu(), ExpirePollRetransmitTimer(), and ExpireRbsTimer().

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

◆ DoTransmitPdcpPdu()

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

RLC SAP.

Parameters
ppacket

Store PDCP PDU

Report Buffer Status

Implements ns3::LteRlc.

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

References ns3::Packet::AddPacketTag(), ns3::EventId::Cancel(), DoReportBufferStatus(), ExpireRbsTimer(), ns3::LteRlcSduStatusTag::FULL_SDU, ns3::Packet::GetSize(), ns3::LteRlc::m_lcid, m_maxTxBufferSize, m_rbsTimer, m_rbsTimerValue, ns3::LteRlc::m_rnti, ns3::LteRlc::m_txDropTrace, m_txonBuffer, m_txonBufferSize, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), and ns3::LteRlcSduStatusTag::SetStatus().

+ Here is the call graph for this function:

◆ ExpirePollRetransmitTimer()

void ns3::LteRlcAm::ExpirePollRetransmitTimer ( )
private

Expire poll retransmitter.

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

References DoReportBufferStatus(), ns3::SequenceNumber10::GetValue(), m_pollRetransmitTimerJustExpired, m_retxBuffer, m_retxBufferSize, m_statusPduRequested, m_txedBuffer, m_txedBufferSize, m_txonBufferSize, m_vtA, m_vtMs, m_vtS, ns3::MilliSeconds(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_LOGIC.

Referenced by DoNotifyTxOpportunity().

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

◆ ExpireRbsTimer()

void ns3::LteRlcAm::ExpireRbsTimer ( )
private

Expire RBS timer.

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

References DoReportBufferStatus(), m_rbsTimer, m_rbsTimerValue, m_retxBufferSize, m_txedBufferSize, m_txonBufferSize, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Referenced by DoTransmitPdcpPdu().

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

◆ ExpireReorderingTimer()

void ns3::LteRlcAm::ExpireReorderingTimer ( )
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 1691 of file lte-rlc-am.cc.

References ns3::SequenceNumber10::GetValue(), m_reorderingTimer, m_reorderingTimerValue, m_rxonBuffer, m_statusPduRequested, m_vrH, m_vrMs, m_vrX, NS_ASSERT_MSG, NS_LOG_FUNCTION, 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:

◆ ExpireStatusProhibitTimer()

void ns3::LteRlcAm::ExpireStatusProhibitTimer ( )
private

method called when the T_status_prohibit timer expires

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

References NS_LOG_FUNCTION.

Referenced by DoNotifyTxOpportunity().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References m_maxTxBufferSize, m_pollRetransmitTimerValue, m_rbsTimerValue, m_reorderingTimerValue, m_statusProhibitTimerValue, m_txOpportunityForRetxAlwaysBigEnough, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().

Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), ns3::LteEnbRrc::GetRlcType(), and ns3::UeManager::SetupDataRadioBearer().

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

◆ IsInsideReceivingWindow()

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

method called when the T_status_prohibit timer expires

Parameters
seqNumberSequenceNumber10
Returns
true is inside receiving window

Definition at line 1161 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:

◆ ReassembleAndDeliver()

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

Reassemble and deliver.

Parameters
packetthe packet
Todo:
What to do in this case? Discard packet and continue? Or Assert?

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 1183 of file lte-rlc-am.cc.

References ns3::Packet::AddAtEnd(), ns3::Packet::CreateFragment(), ns3::Packet::FindFirstMatchingByteTag(), ns3::LteRlcAmHeader::FIRST_BYTE, ns3::LteRlcAmHeader::GetFramingInfo(), ns3::LteRlcAmHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::LteRlcAmHeader::LAST_BYTE, m_expectedSeqNumber, m_keepS0, m_reassemblingState, ns3::LteRlc::m_rlcSapUser, m_sdusBuffer, ns3::LteRlcAmHeader::NO_FIRST_BYTE, ns3::LteRlcAmHeader::NO_LAST_BYTE, NS_ASSERT, NS_LOG_LOGIC, ns3::LteRlcAmHeader::PopExtensionBit(), ns3::LteRlcAmHeader::PopLengthIndicator(), ns3::LteRlcSapUser::ReceivePdcpPdu(), ns3::Packet::RemoveAtStart(), ns3::Packet::RemoveHeader(), WAITING_S0_FULL, and WAITING_SI_SF.

Referenced by DoReceivePdu().

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

Member Data Documentation

◆ m_byteWithoutPoll

uint32_t ns3::LteRlcAm::m_byteWithoutPoll
private

byte without poll

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

Referenced by LteRlcAm(), and DoNotifyTxOpportunity().

◆ m_controlPduBuffer

Ptr<Packet> ns3::LteRlcAm::m_controlPduBuffer
private

Control PDU buffer (just one PDU)

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

Referenced by DoDispose().

◆ m_expectedSeqNumber

SequenceNumber10 ns3::LteRlcAm::m_expectedSeqNumber
private

Expected Sequence Number.

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

Referenced by LteRlcAm(), and ReassembleAndDeliver().

◆ m_keepS0

Ptr<Packet> ns3::LteRlcAm::m_keepS0
private

keep S0

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

Referenced by DoDispose(), and ReassembleAndDeliver().

◆ m_maxRetxThreshold

uint16_t ns3::LteRlcAm::m_maxRetxThreshold
private

Configurable parameters.

See section 7.4 in TS 36.322

Todo:
How these parameters are configured???

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

Referenced by LteRlcAm(), and DoNotifyTxOpportunity().

◆ m_maxTxBufferSize

uint32_t ns3::LteRlcAm::m_maxTxBufferSize
private

maximum transmission buffer size

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

Referenced by DoDispose(), DoTransmitPdcpPdu(), and GetTypeId().

◆ m_pduWithoutPoll

uint32_t ns3::LteRlcAm::m_pduWithoutPoll
private

Counters.

See section 7.1 in TS 36.322 PDU without poll

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

Referenced by LteRlcAm(), and DoNotifyTxOpportunity().

◆ m_pollByte

uint16_t ns3::LteRlcAm::m_pollByte
private

poll byte

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

Referenced by LteRlcAm(), and DoNotifyTxOpportunity().

◆ m_pollPdu

uint16_t ns3::LteRlcAm::m_pollPdu
private

poll PDU

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

Referenced by LteRlcAm(), and DoNotifyTxOpportunity().

◆ m_pollRetransmitTimer

EventId ns3::LteRlcAm::m_pollRetransmitTimer
private

Timers.

See section 7.3 in TS 36.322 poll retransmit timer

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

Referenced by DoDispose(), DoNotifyTxOpportunity(), and DoReceivePdu().

◆ m_pollRetransmitTimerJustExpired

bool ns3::LteRlcAm::m_pollRetransmitTimerJustExpired
private

poll retransmit timer just expired?

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), and ExpirePollRetransmitTimer().

◆ m_pollRetransmitTimerValue

Time ns3::LteRlcAm::m_pollRetransmitTimerValue
private

poll retransmit time value

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

Referenced by DoNotifyTxOpportunity(), and GetTypeId().

◆ m_pollSn

SequenceNumber10 ns3::LteRlcAm::m_pollSn
private

POLL_SN.

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), and DoReceivePdu().

◆ m_rbsTimer

EventId ns3::LteRlcAm::m_rbsTimer
private

RBS timer.

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

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

◆ m_rbsTimerValue

Time ns3::LteRlcAm::m_rbsTimerValue
private

RBS timer value.

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

Referenced by DoTransmitPdcpPdu(), ExpireRbsTimer(), and GetTypeId().

◆ m_reassemblingState

ReassemblingState_t ns3::LteRlcAm::m_reassemblingState
private

reassembling state

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

Referenced by LteRlcAm(), and ReassembleAndDeliver().

◆ m_reorderingTimer

EventId ns3::LteRlcAm::m_reorderingTimer
private

reordering timer

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

Referenced by DoDispose(), DoReceivePdu(), and ExpireReorderingTimer().

◆ m_reorderingTimerValue

Time ns3::LteRlcAm::m_reorderingTimerValue
private

reordering timer value

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

Referenced by DoReceivePdu(), ExpireReorderingTimer(), and GetTypeId().

◆ m_retxBuffer

std::vector<RetxPdu> ns3::LteRlcAm::m_retxBuffer
private

Buffer for PDUs considered for retransmission.

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

Referenced by LteRlcAm(), DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), and ExpirePollRetransmitTimer().

◆ m_retxBufferSize

uint32_t ns3::LteRlcAm::m_retxBufferSize
private

retransmit buffer size

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

Referenced by LteRlcAm(), DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), ExpirePollRetransmitTimer(), and ExpireRbsTimer().

◆ m_rxonBuffer

std::map<uint16_t, PduBuffer> ns3::LteRlcAm::m_rxonBuffer
private

Reception buffer.

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

Referenced by DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), and ExpireReorderingTimer().

◆ m_sdusBuffer

std::list<Ptr<Packet> > ns3::LteRlcAm::m_sdusBuffer
private

List of SDUs in a packet (PDU)

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

Referenced by DoDispose(), and ReassembleAndDeliver().

◆ m_statusPduBufferSize

uint32_t ns3::LteRlcAm::m_statusPduBufferSize
private

status PDU buffer size

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), and DoReportBufferStatus().

◆ m_statusPduRequested

bool ns3::LteRlcAm::m_statusPduRequested
private

status PDU requested

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), ExpirePollRetransmitTimer(), and ExpireReorderingTimer().

◆ m_statusProhibitTimer

EventId ns3::LteRlcAm::m_statusProhibitTimer
private

status prohibit timer

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

Referenced by DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), and DoReportBufferStatus().

◆ m_statusProhibitTimerValue

Time ns3::LteRlcAm::m_statusProhibitTimerValue
private

status prohibit timer value

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

Referenced by DoNotifyTxOpportunity(), and GetTypeId().

◆ m_txedBuffer

std::vector<RetxPdu> ns3::LteRlcAm::m_txedBuffer
private

Buffer for transmitted and retransmitted PDUs that have not been acked but are not considered for retransmission.

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

Referenced by LteRlcAm(), DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), and ExpirePollRetransmitTimer().

◆ m_txedBufferSize

uint32_t ns3::LteRlcAm::m_txedBufferSize
private

transmit ed buffer size

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

Referenced by LteRlcAm(), DoDispose(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), ExpirePollRetransmitTimer(), and ExpireRbsTimer().

◆ m_txonBuffer

std::vector<TxPdu> ns3::LteRlcAm::m_txonBuffer
private

Transmission buffer.

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

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

◆ m_txonBufferSize

uint32_t ns3::LteRlcAm::m_txonBufferSize
private

transmit on buffer size

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

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

◆ m_txOpportunityForRetxAlwaysBigEnough

bool ns3::LteRlcAm::m_txOpportunityForRetxAlwaysBigEnough
private

transmit opportunity for retransmit?

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

Referenced by DoNotifyTxOpportunity(), and GetTypeId().

◆ m_vrH

SequenceNumber10 ns3::LteRlcAm::m_vrH
private

VR(H)

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

Referenced by LteRlcAm(), DoReceivePdu(), and ExpireReorderingTimer().

◆ m_vrMr

SequenceNumber10 ns3::LteRlcAm::m_vrMr
private

VR(MR)

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

Referenced by LteRlcAm(), DoReceivePdu(), and IsInsideReceivingWindow().

◆ m_vrMs

SequenceNumber10 ns3::LteRlcAm::m_vrMs
private

VR(MS)

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), and ExpireReorderingTimer().

◆ m_vrR

SequenceNumber10 ns3::LteRlcAm::m_vrR
private

VR(R)

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), and IsInsideReceivingWindow().

◆ m_vrX

SequenceNumber10 ns3::LteRlcAm::m_vrX
private

VR(X)

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

Referenced by LteRlcAm(), DoReceivePdu(), and ExpireReorderingTimer().

◆ m_vtA

SequenceNumber10 ns3::LteRlcAm::m_vtA
private

State variables.

See section 7.1 in TS 36.322 VT(A)

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), and ExpirePollRetransmitTimer().

◆ m_vtMs

SequenceNumber10 ns3::LteRlcAm::m_vtMs
private

VT(MS)

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), and ExpirePollRetransmitTimer().

◆ m_vtS

SequenceNumber10 ns3::LteRlcAm::m_vtS
private

VT(S)

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

Referenced by LteRlcAm(), DoNotifyTxOpportunity(), DoReceivePdu(), DoReportBufferStatus(), and ExpirePollRetransmitTimer().

◆ m_windowSize

uint16_t ns3::LteRlcAm::m_windowSize
private

Constants.

See section 7.2 in TS 36.322

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

Referenced by LteRlcAm(), and DoReceivePdu().

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