A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::LteRlcUm Class Reference

#include <lte-rlc-um.h>

+ Inheritance diagram for ns3::LteRlcUm:
+ Collaboration diagram for ns3::LteRlcUm:

Public Member Functions

 LteRlcUm ()
virtual ~LteRlcUm ()
virtual void DoDispose ()
virtual void DoNotifyHarqDeliveryFailure ()
virtual void DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId)
virtual void DoReceivePdu (Ptr< Packet > p)
virtual void DoTransmitPdcpPdu (Ptr< Packet > p)
- 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
void Initialize (void)
- 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 DoReportBufferStatus ()
void ExpireRbsTimer (void)
void ExpireReorderingTimer (void)
bool IsInsideReorderingWindow (SequenceNumber10 seqNumber)
void ReassembleAndDeliver (Ptr< Packet > packet)
void ReassembleOutsideWindow (void)
void ReassembleSnInterval (SequenceNumber10 lowSeqNumber, SequenceNumber10 highSeqNumber)

Private Attributes

SequenceNumber10 m_expectedSeqNumber
Ptr< Packet > m_keepS0
uint32_t m_maxTxBufferSize
EventId m_rbsTimer
std::vector< Ptr< Packet > > m_reasBuffer
ReassemblingState_t m_reassemblingState
EventId m_reorderingTimer
std::map< uint16_t, Ptr< Packet > > m_rxBuffer
std::list< Ptr< Packet > > m_sdusBuffer
SequenceNumber10 m_sequenceNumber
std::vector< Ptr< Packet > > m_txBuffer
uint32_t m_txBufferSize
SequenceNumber10 m_vrUh
SequenceNumber10 m_vrUr
SequenceNumber10 m_vrUx
uint16_t m_windowSize

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoInitialize (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 Unacknowledged Mode (UM), see 3GPP TS 36.322

Config Paths

ns3::LteRlcUm 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::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb0/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb1/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/DataRadioBearerMap/[i]/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb0/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]/Srb1/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/DataRadioBearerMap/[i]/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/Srb0/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeRrc/Srb1/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/DataRadioBearerMap/[i]/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/Srb0/LteRlc/$ns3::LteRlcUm
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeRrc/Srb1/LteRlc/$ns3::LteRlcUm

Attributes

  • MaxTxBufferSize: Maximum Size of the Transmission Buffer (in Bytes)

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

Member Enumeration Documentation

enum ns3::LteRlcUm::ReassemblingState_t
private

Reassembling state

Enumerator:
NONE 
WAITING_S0_FULL 
WAITING_SI_SF 

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

Constructor & Destructor Documentation

ns3::LteRlcUm::LteRlcUm ( )

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

References m_reassemblingState, NS_LOG_FUNCTION, and WAITING_S0_FULL.

ns3::LteRlcUm::~LteRlcUm ( )
virtual

Definition at line 49 of file lte-rlc-um.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteRlcUm::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 70 of file lte-rlc-um.cc.

References ns3::EventId::Cancel(), m_rbsTimer, m_reorderingTimer, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::LteRlcUm::DoNotifyHarqDeliveryFailure ( )
virtual

Implements ns3::LteRlc.

Definition at line 395 of file lte-rlc-um.cc.

References NS_LOG_FUNCTION.

void ns3::LteRlcUm::DoNotifyTxOpportunity ( uint32_t  bytes,
uint8_t  layer,
uint8_t  harqId 
)
virtual

MAC SAP

Implements ns3::LteRlc.

Definition at line 126 of file lte-rlc-um.cc.

References ns3::Packet::AddAtEnd(), ns3::Packet::AddByteTag(), ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::EventId::Cancel(), ns3::Packet::Copy(), ns3::Packet::CreateFragment(), ns3::LteRlcHeader::DATA_FIELD_FOLLOWS, ns3::LteRlcHeader::E_LI_FIELDS_FOLLOWS, ExpireRbsTimer(), ns3::LteRlcHeader::FIRST_BYTE, ns3::LteRlcSduStatusTag::FIRST_SEGMENT, ns3::LteRlcSduStatusTag::FULL_SDU, ns3::Packet::GetSize(), ns3::LteRlcSduStatusTag::GetStatus(), ns3::LteRlcHeader::LAST_BYTE, ns3::LteRlcSduStatusTag::LAST_SEGMENT, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_rbsTimer, ns3::LteRlc::m_rnti, m_sequenceNumber, m_txBuffer, m_txBufferSize, ns3::LteRlc::m_txPdu, ns3::LteRlcSduStatusTag::MIDDLE_SEGMENT, ns3::MilliSeconds(), ns3::LteRlcHeader::NO_FIRST_BYTE, ns3::LteRlcHeader::NO_LAST_BYTE, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LteMacSapProvider::TransmitPduParameters::pdu, ns3::Packet::RemoveAtStart(), ns3::Packet::RemovePacketTag(), ns3::Simulator::Schedule(), and ns3::LteMacSapProvider::TransmitPdu().

+ Here is the call graph for this function:

void ns3::LteRlcUm::DoReceivePdu ( Ptr< Packet >  p)
virtual

Implements ns3::LteRlc.

Definition at line 401 of file lte-rlc-um.cc.

References ns3::EventId::Cancel(), ExpireReorderingTimer(), ns3::Packet::FindFirstMatchingByteTag(), ns3::Time::GetNanoSeconds(), ns3::Packet::GetSize(), ns3::SequenceNumber10::GetValue(), IsInsideReorderingWindow(), ns3::EventId::IsRunning(), ns3::LteRlc::m_lcid, m_reorderingTimer, ns3::LteRlc::m_rnti, m_rxBuffer, ns3::LteRlc::m_rxPdu, m_vrUh, m_vrUr, m_vrUx, m_windowSize, ns3::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::PeekHeader(), ReassembleOutsideWindow(), ReassembleSnInterval(), ns3::Simulator::Schedule(), and ns3::SequenceNumber10::SetModulusBase().

+ Here is the call graph for this function:

void ns3::LteRlcUm::DoReportBufferStatus ( void  )
private

Definition at line 1111 of file lte-rlc-um.cc.

References ns3::Time::GetMilliSeconds(), ns3::RlcTag::GetSenderTimestamp(), ns3::LteMacSapProvider::ReportBufferStatusParameters::lcid, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, ns3::LteRlc::m_rnti, m_txBuffer, m_txBufferSize, ns3::Now(), NS_LOG_LOGIC, ns3::LteMacSapProvider::ReportBufferStatus(), ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueHolDelay, ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::rnti, ns3::LteMacSapProvider::ReportBufferStatusParameters::statusPduSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueHolDelay, and ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueSize.

Referenced by DoTransmitPdcpPdu(), and ExpireRbsTimer().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteRlcUm::DoTransmitPdcpPdu ( Ptr< Packet >  p)
virtual

RLC SAP

Store arrival time

Store PDCP PDU

Report Buffer Status

Implements ns3::LteRlc.

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

References ns3::Packet::AddPacketTag(), ns3::EventId::Cancel(), DoReportBufferStatus(), ns3::LteRlcSduStatusTag::FULL_SDU, 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, NS_LOG_LOGIC, and ns3::LteRlcSduStatusTag::SetStatus().

+ Here is the call graph for this function:

void ns3::LteRlcUm::ExpireRbsTimer ( void  )
private

Definition at line 1179 of file lte-rlc-um.cc.

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

Referenced by DoNotifyTxOpportunity().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteRlcUm::ExpireReorderingTimer ( void  )
private

Definition at line 1140 of file lte-rlc-um.cc.

References ns3::SequenceNumber10::GetValue(), ns3::LteRlc::m_lcid, m_reorderingTimer, ns3::LteRlc::m_rnti, m_rxBuffer, m_vrUh, m_vrUr, m_vrUx, NS_LOG_FUNCTION, NS_LOG_LOGIC, ReassembleSnInterval(), 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::LteRlcUm::GetTypeId ( void  )
static

Reimplemented from ns3::LteRlc.

Definition at line 55 of file lte-rlc-um.cc.

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

+ Here is the call graph for this function:

bool ns3::LteRlcUm::IsInsideReorderingWindow ( SequenceNumber10  seqNumber)
private

Definition at line 564 of file lte-rlc-um.cc.

References m_vrUh, m_windowSize, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SequenceNumber10::SetModulusBase().

Referenced by DoReceivePdu(), and ReassembleOutsideWindow().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Deliver one or multiple PDUs

Deliver full PDUs

Keep S0

Discard SI or SN

Deliver zero, one or multiple PDUs

Discard SI or SN

Deliver zero, one or multiple 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 587 of file lte-rlc-um.cc.

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

Referenced by ReassembleOutsideWindow(), and ReassembleSnInterval().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteRlcUm::ReassembleOutsideWindow ( void  )
private

Definition at line 1054 of file lte-rlc-um.cc.

References IsInsideReorderingWindow(), m_rxBuffer, NS_LOG_LOGIC, and ReassembleAndDeliver().

Referenced by DoReceivePdu().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteRlcUm::ReassembleSnInterval ( SequenceNumber10  lowSeqNumber,
SequenceNumber10  highSeqNumber 
)
private

Definition at line 1080 of file lte-rlc-um.cc.

References ns3::SequenceNumber10::GetValue(), m_rxBuffer, NS_LOG_LOGIC, and ReassembleAndDeliver().

Referenced by DoReceivePdu(), and ExpireReorderingTimer().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

SequenceNumber10 ns3::LteRlcUm::m_expectedSeqNumber
private

Expected Sequence Number

Definition at line 109 of file lte-rlc-um.h.

Referenced by ReassembleAndDeliver().

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

Definition at line 104 of file lte-rlc-um.h.

Referenced by ReassembleAndDeliver().

uint32_t ns3::LteRlcUm::m_maxTxBufferSize
private

Definition at line 69 of file lte-rlc-um.h.

Referenced by DoTransmitPdcpPdu(), and GetTypeId().

EventId ns3::LteRlcUm::m_rbsTimer
private

Definition at line 95 of file lte-rlc-um.h.

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

std::vector< Ptr<Packet> > ns3::LteRlcUm::m_reasBuffer
private

Definition at line 73 of file lte-rlc-um.h.

ReassemblingState_t ns3::LteRlcUm::m_reassemblingState
private

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

Referenced by LteRlcUm(), and ReassembleAndDeliver().

EventId ns3::LteRlcUm::m_reorderingTimer
private

Timers. See section 7.3 in TS 36.322

Definition at line 94 of file lte-rlc-um.h.

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

std::map<uint16_t, Ptr<Packet> > ns3::LteRlcUm::m_rxBuffer
private

Definition at line 72 of file lte-rlc-um.h.

Referenced by DoReceivePdu(), ExpireReorderingTimer(), ReassembleOutsideWindow(), and ReassembleSnInterval().

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

Definition at line 75 of file lte-rlc-um.h.

Referenced by ReassembleAndDeliver().

SequenceNumber10 ns3::LteRlcUm::m_sequenceNumber
private

State variables. See section 7.1 in TS 36.322

Definition at line 80 of file lte-rlc-um.h.

Referenced by DoNotifyTxOpportunity().

std::vector< Ptr<Packet> > ns3::LteRlcUm::m_txBuffer
private

Definition at line 71 of file lte-rlc-um.h.

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

uint32_t ns3::LteRlcUm::m_txBufferSize
private

Definition at line 70 of file lte-rlc-um.h.

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

SequenceNumber10 ns3::LteRlcUm::m_vrUh
private

Definition at line 84 of file lte-rlc-um.h.

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

SequenceNumber10 ns3::LteRlcUm::m_vrUr
private

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

Referenced by DoReceivePdu(), and ExpireReorderingTimer().

SequenceNumber10 ns3::LteRlcUm::m_vrUx
private

Definition at line 83 of file lte-rlc-um.h.

Referenced by DoReceivePdu(), and ExpireReorderingTimer().

uint16_t ns3::LteRlcUm::m_windowSize
private

Constants. See section 7.2 in TS 36.322

Definition at line 89 of file lte-rlc-um.h.

Referenced by DoReceivePdu(), and IsInsideReorderingWindow().

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