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

Manages all the radio bearer information possessed by the ENB RRC for a single UE. More...

#include "lte-enb-rrc.h"

+ Inheritance diagram for ns3::UeManager:
+ Collaboration diagram for ns3::UeManager:

Public Types

enum  State {
  INITIAL_RANDOM_ACCESS = 0, CONNECTION_SETUP, CONNECTION_REJECTED, CONNECTED_NORMALLY,
  CONNECTION_RECONFIGURATION, CONNECTION_REESTABLISHMENT, HANDOVER_PREPARATION, HANDOVER_JOINING,
  HANDOVER_PATH_SWITCH, HANDOVER_LEAVING, NUM_STATES
}
 The state of the UeManager at the eNB RRC. More...
 
typedef void(* StateTracedCallback) (uint64_t imsi, uint16_t cellId, uint16_t rnti, State oldState, State newState)
 TracedCallback signature for state transition events. More...
 

Public Member Functions

 UeManager ()
 
 UeManager (Ptr< LteEnbRrc > rrc, uint16_t rnti, State s)
 UeManager constructor. More...
 
virtual ~UeManager (void)
 
void CmacUeConfigUpdateInd (LteEnbCmacSapUser::UeConfig cmacParams)
 
void CompleteSetupUe (LteEnbRrcSapProvider::CompleteSetupUeParameters params)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::CompleteSetupUe interface. More...
 
void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params)
 
std::vector< EpcX2Sap::ErabToBeSetupItemGetErabList ()
 
uint64_t GetImsi (void) const
 
LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigForHandoverPreparationInfo ()
 
uint16_t GetRnti (void) const
 
LteRrcSap::RrcConnectionReconfiguration GetRrcConnectionReconfigurationForHandover ()
 
uint16_t GetSrsConfigurationIndex (void) const
 
State GetState () const
 
void PrepareHandover (uint16_t cellId)
 Start the handover preparation and send the handover request. More...
 
void RecordDataRadioBearersToBeStarted ()
 Start all configured data radio bearers. More...
 
void RecvHandoverPreparationFailure (uint16_t cellId)
 Take the necessary actions in response to the reception of an X2 HO preparation failure message. More...
 
void RecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params)
 take the necessary actions in response to the reception of an X2 HANDOVER REQUEST ACK message More...
 
void RecvMeasurementReport (LteRrcSap::MeasurementReport msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvMeasurementReport interface. More...
 
void RecvRrcConnectionReconfigurationCompleted (LteRrcSap::RrcConnectionReconfigurationCompleted msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionReconfigurationCompleted interface. More...
 
void RecvRrcConnectionReestablishmentComplete (LteRrcSap::RrcConnectionReestablishmentComplete msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface. More...
 
void RecvRrcConnectionReestablishmentRequest (LteRrcSap::RrcConnectionReestablishmentRequest msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentRequest interface. More...
 
void RecvRrcConnectionRequest (LteRrcSap::RrcConnectionRequest msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionRequest interface. More...
 
void RecvRrcConnectionSetupCompleted (LteRrcSap::RrcConnectionSetupCompleted msg)
 Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionSetupCompleted interface. More...
 
void RecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params)
 Take the necessary actions in response to the reception of an X2 SN STATUS TRANSFER message. More...
 
void RecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params)
 Take the necessary actions in response to the reception of an X2 UE CONTEXT RELEASE message. More...
 
void ReleaseDataRadioBearer (uint8_t drbid)
 Release a given radio bearer. More...
 
void ScheduleRrcConnectionReconfiguration ()
 schedule an RRC Connection Reconfiguration procedure with the UE More...
 
void SendData (uint8_t bid, Ptr< Packet > p)
 Send a data packet over the appropriate Data Radio Bearer. More...
 
void SendUeContextRelease ()
 send the UE CONTEXT RELEASE X2 message to the source eNB, thus successfully terminating an X2 handover procedure More...
 
void SetImsi (uint64_t imsi)
 Set the IMSI. More...
 
void SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated)
 Configure PdschConfigDedicated (i.e. More...
 
void SetSource (uint16_t sourceCellId, uint16_t sourceX2apId)
 Set the identifiers of the source eNB for the case where a UE joins the current eNB as part of a handover procedure. More...
 
void SetSrsConfigurationIndex (uint16_t srsConfIndex)
 Set the SRS configuration index and do the necessary reconfiguration. More...
 
void SetupDataRadioBearer (EpsBearer bearer, uint8_t bearerId, uint32_t gtpTeid, Ipv4Address transportLayerAddress)
 Setup a new data radio bearer, including both the configuration within the eNB and the necessary RRC signaling with the UE. More...
 
void StartDataRadioBearers ()
 Start the data radio bearers that have been previously recorded to be started using RecordDataRadioBearersToBeStarted() More...
 
- 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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
 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. 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)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Member Functions

uint8_t AddDataRadioBearerInfo (Ptr< LteDataRadioBearerInfo > radioBearerInfo)
 Add a new LteDataRadioBearerInfo structure to the UeManager. More...
 
uint8_t Bid2Drbid (uint8_t bid)
 
uint8_t Bid2Lcid (uint8_t bid)
 
LteRrcSap::RadioResourceConfigDedicated BuildRadioResourceConfigDedicated ()
 
LteRrcSap::RrcConnectionReconfiguration BuildRrcConnectionReconfiguration ()
 
uint8_t Drbid2Bid (uint8_t drbid)
 
uint8_t Drbid2Lcid (uint8_t drbid)
 
Ptr< LteDataRadioBearerInfoGetDataRadioBearerInfo (uint8_t drbid)
 
uint8_t GetNewRrcTransactionIdentifier ()
 
uint8_t Lcid2Bid (uint8_t lcid)
 
uint8_t Lcid2Drbid (uint8_t lcid)
 
void RemoveDataRadioBearerInfo (uint8_t drbid)
 remove the LteDataRadioBearerInfo corresponding to a bearer being released More...
 
void SwitchToState (State s)
 Switch the UeManager to the given state. More...
 

Private Attributes

EventId m_connectionRejectedTimeout
 The delay before a connection rejected timeout occurs. More...
 
EventId m_connectionRequestTimeout
 Time limit before a connection request timeout occurs. More...
 
EventId m_connectionSetupTimeout
 Time limit before a connection setup timeout occurs. More...
 
std::map< uint8_t, Ptr< LteDataRadioBearerInfo > > m_drbMap
 The DataRadioBearerMap attribute. More...
 
LtePdcpSapUserm_drbPdcpSapUser
 
std::list< uint8_t > m_drbsToBeStarted
 
EventId m_handoverJoiningTimeout
 Time limit before a handover joining timeout occurs. More...
 
EventId m_handoverLeavingTimeout
 Time limit before a handover leaving timeout occurs. More...
 
uint64_t m_imsi
 International Mobile Subscriber Identity assigned to this UE. More...
 
uint8_t m_lastAllocatedDrbid
 
uint8_t m_lastRrcTransactionIdentifier
 
bool m_needPhyMacConfiguration
 
bool m_pendingRrcConnectionReconfiguration
 
LteRrcSap::PhysicalConfigDedicated m_physicalConfigDedicated
 
uint16_t m_rnti
 The C-RNTI attribute. More...
 
Ptr< LteEnbRrcm_rrc
 Pointer to the parent eNodeB RRC. More...
 
uint16_t m_sourceCellId
 
uint16_t m_sourceX2apId
 
Ptr< LteSignalingRadioBearerInfom_srb0
 The Srb0 attribute. More...
 
Ptr< LteSignalingRadioBearerInfom_srb1
 The Srb1 attribute. More...
 
State m_state
 The current UeManager state. More...
 
TracedCallback< uint64_t, uint16_t, uint16_t, State, Statem_stateTransitionTrace
 The StateTransition trace source. More...
 
uint16_t m_targetCellId
 

Friends

class LtePdcpSpecificLtePdcpSapUser< UeManager >
 

Additional Inherited Members

Detailed Description

Manages all the radio bearer information possessed by the ENB RRC for a single UE.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc/UeMap/[i]"

Attributes

TraceSources

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

Definition at line 62 of file lte-enb-rrc.h.

Member Typedef Documentation

typedef void(* ns3::UeManager::StateTracedCallback) (uint64_t imsi, uint16_t cellId, uint16_t rnti, State oldState, State newState)

TracedCallback signature for state transition events.

Parameters
[in]imsi
[in]cellId
[in]rnti
[in]oldState
[in]newState

Definition at line 317 of file lte-enb-rrc.h.

Constructor & Destructor Documentation

ns3::UeManager::UeManager ( )

Definition at line 129 of file lte-enb-rrc.cc.

References NS_FATAL_ERROR.

ns3::UeManager::UeManager ( Ptr< LteEnbRrc rrc,
uint16_t  rnti,
State  s 
)

UeManager constructor.

Parameters
rrcpointer to the LteEnbRrc holding this UeManager
rntiRNTI of the UE
sinitial state of the UeManager
Returns

Definition at line 135 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

ns3::UeManager::~UeManager ( void  )
virtual

Definition at line 267 of file lte-enb-rrc.cc.

Member Function Documentation

uint8_t ns3::UeManager::AddDataRadioBearerInfo ( Ptr< LteDataRadioBearerInfo radioBearerInfo)
private

Add a new LteDataRadioBearerInfo structure to the UeManager.

Parameters
radioBearerInfo
Returns
the id of the newly added data radio bearer structure

Definition at line 1108 of file lte-enb-rrc.cc.

References m_drbMap, m_lastAllocatedDrbid, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by SetupDataRadioBearer().

+ Here is the caller graph for this function:

uint8_t ns3::UeManager::Bid2Drbid ( uint8_t  bid)
private
Parameters
bidan EPS Bearer Identifier
Returns
the corresponding Data Radio Bearer Id

Definition at line 1235 of file lte-enb-rrc.cc.

Referenced by SendData().

+ Here is the caller graph for this function:

uint8_t ns3::UeManager::Bid2Lcid ( uint8_t  bid)
private
Parameters
bidan EPS Bearer Identifier
Returns
the corresponding Logical Channel Identifier

Definition at line 1223 of file lte-enb-rrc.cc.

Referenced by SendData().

+ Here is the caller graph for this function:

void ns3::UeManager::DoDispose ( void  )
protectedvirtual

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

Definition at line 272 of file lte-enb-rrc.cc.

References m_drbMap, m_drbPdcpSapUser, and m_rrc.

void ns3::UeManager::DoInitialize ( void  )
protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 151 of file lte-enb-rrc.cc.

References ns3::LteRrcSap::PhysicalConfigDedicated::antennaInfo, ns3::LteEnbRrc::ConnectionRequestTimeout(), ns3::LteRrcSap::PdschConfigDedicated::dB0, ns3::EpsBearer::GBR_CONV_VOICE, ns3::LteEnbCmacSapProvider::LcInfo::gbrDl, ns3::LteEnbCmacSapProvider::LcInfo::gbrUl, ns3::LteRlc::GetLteMacSapUser(), ns3::LteRlc::GetLteRlcSapProvider(), HANDOVER_JOINING, ns3::LteEnbRrc::HandoverJoiningTimeout(), ns3::LteRrcSap::PhysicalConfigDedicated::haveAntennaInfoDedicated, ns3::LteRrcSap::PhysicalConfigDedicated::havePdschConfigDedicated, ns3::LteRrcSap::PhysicalConfigDedicated::haveSoundingRsUlConfigDedicated, INITIAL_RANDOM_ACCESS, ns3::LteEnbCmacSapProvider::LcInfo::isGbr, ns3::LteEnbCmacSapProvider::LcInfo::lcGroup, ns3::LteEnbCmacSapProvider::LcInfo::lcId, m_connectionRequestTimeout, m_drbPdcpSapUser, m_handoverJoiningTimeout, m_physicalConfigDedicated, ns3::LteEnbCmacSapProvider::UeConfig::m_rnti, m_rnti, m_rrc, m_srb0, m_srb1, m_state, ns3::LteEnbCmacSapProvider::UeConfig::m_transmissionMode, ns3::LteEnbCmacSapProvider::LcInfo::mbrDl, ns3::LteEnbCmacSapProvider::LcInfo::mbrUl, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::LteRrcSap::PdschConfigDedicated::pa, ns3::LteRrcSap::PhysicalConfigDedicated::pdschConfigDedicated, ns3::LteEnbCmacSapProvider::LcInfo::qci, ns3::LteEnbCmacSapProvider::LcInfo::rnti, ns3::Simulator::Schedule(), ns3::LteRlc::SetLcId(), ns3::LteRlc::SetLteMacSapProvider(), ns3::LteRlc::SetLteRlcSapUser(), ns3::LteRlc::SetRnti(), ns3::LteRrcSap::SoundingRsUlConfigDedicated::SETUP, ns3::LteRrcSap::PhysicalConfigDedicated::soundingRsUlConfigDedicated, ns3::LteEnbRrcSapUser::SetupUeParameters::srb0SapProvider, ns3::LteEnbRrcSapUser::SetupUeParameters::srb1SapProvider, ns3::LteRrcSap::SoundingRsUlConfigDedicated::srsBandwidth, ns3::LteRrcSap::SoundingRsUlConfigDedicated::srsConfigIndex, ns3::ToString(), ns3::LteRrcSap::AntennaInfoDedicated::transmissionMode, and ns3::LteRrcSap::SoundingRsUlConfigDedicated::type.

+ Here is the call graph for this function:

uint8_t ns3::UeManager::Drbid2Bid ( uint8_t  drbid)
private
Parameters
drbidData Radio Bearer Id
Returns
the corresponding EPS Bearer Identifier

Definition at line 1229 of file lte-enb-rrc.cc.

Referenced by SetupDataRadioBearer().

+ Here is the caller graph for this function:

uint8_t ns3::UeManager::Drbid2Lcid ( uint8_t  drbid)
private
Parameters
drbida Data Radio Bearer Id
Returns
the corresponding Logical Channel Identifier

Definition at line 1211 of file lte-enb-rrc.cc.

Referenced by ReleaseDataRadioBearer(), and SetupDataRadioBearer().

+ Here is the caller graph for this function:

Ptr< LteDataRadioBearerInfo > ns3::UeManager::GetDataRadioBearerInfo ( uint8_t  drbid)
private
Parameters
drbidthe Data Radio Bearer id
Returns
the corresponding LteDataRadioBearerInfo

Definition at line 1132 of file lte-enb-rrc.cc.

References m_drbMap, NS_ABORT_IF, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by SendData().

+ Here is the caller graph for this function:

std::vector< EpcX2Sap::ErabToBeSetupItem > ns3::UeManager::GetErabList ( )
uint64_t ns3::UeManager::GetImsi ( void  ) const
Returns
the IMSI, i.e., a globally unique UE identifier

Definition at line 1059 of file lte-enb-rrc.cc.

References m_imsi.

Referenced by LteX2HandoverTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), and ns3::LteStatsCalculator::FindImsiFromEnbRlcPath().

+ Here is the caller graph for this function:

uint8_t ns3::UeManager::GetNewRrcTransactionIdentifier ( )
private
Returns
a newly allocated identifier for a new RRC transaction

Definition at line 1198 of file lte-enb-rrc.cc.

References m_lastRrcTransactionIdentifier.

Referenced by BuildRrcConnectionReconfiguration(), RecvRrcConnectionReestablishmentRequest(), and RecvRrcConnectionRequest().

+ Here is the caller graph for this function:

LteRrcSap::RadioResourceConfigDedicated ns3::UeManager::GetRadioResourceConfigForHandoverPreparationInfo ( )
Returns
the HandoverPreparationInfo sent by the source eNB to the target eNB in the X2-based handover procedure

Definition at line 629 of file lte-enb-rrc.cc.

References BuildRadioResourceConfigDedicated(), and NS_LOG_FUNCTION.

Referenced by PrepareHandover().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint16_t ns3::UeManager::GetRnti ( void  ) const
Returns
the RNTI, i.e., an UE identifier that is unique within the cell

Definition at line 1053 of file lte-enb-rrc.cc.

References m_rnti.

LteRrcSap::RrcConnectionReconfiguration ns3::UeManager::GetRrcConnectionReconfigurationForHandover ( )
Returns
retrieve the data that the target eNB needs to send to the source eNB as the Handover Command in the X2-based handover procedure.
Note
mobility control info is not expected to be filled in (shall be filled in by the caller).

Definition at line 636 of file lte-enb-rrc.cc.

References BuildRrcConnectionReconfiguration(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

uint16_t ns3::UeManager::GetSrsConfigurationIndex ( void  ) const
UeManager::State ns3::UeManager::GetState ( void  ) const
TypeId ns3::UeManager::GetTypeId ( void  )
static
uint8_t ns3::UeManager::Lcid2Bid ( uint8_t  lcid)
private
Parameters
lcida Logical Channel Identifier
Returns
the corresponding EPS Bearer Identifier

Definition at line 1216 of file lte-enb-rrc.cc.

References NS_ASSERT.

Referenced by DoReceivePdcpSdu().

+ Here is the caller graph for this function:

uint8_t ns3::UeManager::Lcid2Drbid ( uint8_t  lcid)
private
Parameters
lcida Logical Channel Identifier
Returns
the corresponding Data Radio Bearer Id

Definition at line 1204 of file lte-enb-rrc.cc.

References NS_ASSERT.

void ns3::UeManager::PrepareHandover ( uint16_t  cellId)

Start the handover preparation and send the handover request.

Parameters
cellIdid of the target cell

Definition at line 526 of file lte-enb-rrc.cc.

References ns3::LteRrcSap::HandoverPreparationInfo::asConfig, ns3::EpcX2Sap::HandoverRequestParams::bearers, ns3::EpcX2Sap::HandoverRequestParams::cause, ns3::LteRrcSap::SystemInformationBlockType1::cellAccessRelatedInfo, ns3::LteRrcSap::CellAccessRelatedInfo::cellIdentity, CONNECTED_NORMALLY, ns3::LteRrcSap::CellAccessRelatedInfo::csgIdentity, ns3::LteRrcSap::CellAccessRelatedInfo::csgIndication, ns3::LteRrcSap::MasterInformationBlock::dlBandwidth, ns3::LteRrcSap::SystemInformationBlockType2::freqInfo, GetErabList(), GetRadioResourceConfigForHandoverPreparationInfo(), HANDOVER_PREPARATION, ns3::EpcX2Sap::HandoverDesirableForRadioReason, m_imsi, m_rnti, m_rrc, m_state, m_targetCellId, ns3::EpcX2Sap::HandoverRequestParams::mmeUeS1apId, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LteEnbCmacSapProvider::RachConfig::numberOfRaPreambles, ns3::LteRrcSap::PreambleInfo::numberOfRaPreambles, ns3::EpcX2Sap::HandoverRequestParams::oldEnbUeX2apId, ns3::LteRrcSap::PlmnIdentityInfo::plmnIdentity, ns3::LteRrcSap::CellAccessRelatedInfo::plmnIdentityInfo, ns3::LteRrcSap::RachConfigCommon::preambleInfo, ns3::LteEnbCmacSapProvider::RachConfig::preambleTransMax, ns3::LteRrcSap::RaSupervisionInfo::preambleTransMax, ns3::LteRrcSap::RadioResourceConfigCommonSib::rachConfigCommon, ns3::LteRrcSap::SystemInformationBlockType2::radioResourceConfigCommon, ns3::LteEnbCmacSapProvider::RachConfig::raResponseWindowSize, ns3::LteRrcSap::RaSupervisionInfo::raResponseWindowSize, ns3::LteRrcSap::RachConfigCommon::raSupervisionInfo, ns3::EpcX2Sap::HandoverRequestParams::rrcContext, ns3::EpcX2Sap::HandoverRequestParams::sourceCellId, ns3::LteRrcSap::AsConfig::sourceDlCarrierFreq, ns3::LteRrcSap::AsConfig::sourceMasterInformationBlock, ns3::LteRrcSap::AsConfig::sourceMeasConfig, ns3::LteRrcSap::AsConfig::sourceRadioResourceConfig, ns3::LteRrcSap::AsConfig::sourceSystemInformationBlockType1, ns3::LteRrcSap::AsConfig::sourceSystemInformationBlockType2, ns3::LteRrcSap::AsConfig::sourceUeIdentity, SwitchToState(), ns3::LteRrcSap::MasterInformationBlock::systemFrameNumber, ns3::EpcX2Sap::HandoverRequestParams::targetCellId, ns3::ToString(), ns3::EpcX2Sap::HandoverRequestParams::ueAggregateMaxBitRateDownlink, ns3::EpcX2Sap::HandoverRequestParams::ueAggregateMaxBitRateUplink, ns3::LteRrcSap::FreqInfo::ulBandwidth, and ns3::LteRrcSap::FreqInfo::ulCarrierFreq.

+ Here is the call graph for this function:

void ns3::UeManager::RecordDataRadioBearersToBeStarted ( )

Start all configured data radio bearers.

It is safe to call this method if any bearer had been already started previously.

Definition at line 420 of file lte-enb-rrc.cc.

References m_drbMap, m_drbsToBeStarted, m_rnti, and NS_LOG_FUNCTION.

Referenced by RecvRrcConnectionRequest(), and ScheduleRrcConnectionReconfiguration().

+ Here is the caller graph for this function:

void ns3::UeManager::RecvHandoverPreparationFailure ( uint16_t  cellId)

Take the necessary actions in response to the reception of an X2 HO preparation failure message.

Parameters
cellIdid of the target cell

Definition at line 744 of file lte-enb-rrc.cc.

References CONNECTED_NORMALLY, HANDOVER_PREPARATION, m_state, m_targetCellId, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, SwitchToState(), and ns3::ToString().

+ Here is the call graph for this function:

void ns3::UeManager::RecvHandoverRequestAck ( EpcX2SapUser::HandoverRequestAckParams  params)
void ns3::UeManager::RecvRrcConnectionReestablishmentComplete ( LteRrcSap::RrcConnectionReestablishmentComplete  msg)

Part of the RRC protocol. Implement the LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface.

Definition at line 962 of file lte-enb-rrc.cc.

References CONNECTED_NORMALLY, NS_LOG_FUNCTION, and SwitchToState().

+ Here is the call graph for this function:

void ns3::UeManager::RecvRrcConnectionSetupCompleted ( LteRrcSap::RrcConnectionSetupCompleted  msg)
void ns3::UeManager::RecvSnStatusTransfer ( EpcX2SapUser::SnStatusTransferParams  params)

Take the necessary actions in response to the reception of an X2 SN STATUS TRANSFER message.

Parameters
paramsthe SN STATUS

Definition at line 762 of file lte-enb-rrc.cc.

References ns3::EpcX2Sap::SnStatusTransferParams::erabsSubjectToStatusTransferList, and NS_LOG_FUNCTION.

void ns3::UeManager::RecvUeContextRelease ( EpcX2SapUser::UeContextReleaseParams  params)

Take the necessary actions in response to the reception of an X2 UE CONTEXT RELEASE message.

Parameters
paramsthe SN STATUS

Definition at line 781 of file lte-enb-rrc.cc.

References ns3::EventId::Cancel(), HANDOVER_LEAVING, m_handoverLeavingTimeout, m_state, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::ToString().

+ Here is the call graph for this function:

void ns3::UeManager::RemoveDataRadioBearerInfo ( uint8_t  drbid)
private

remove the LteDataRadioBearerInfo corresponding to a bearer being released

Parameters
drbidthe Data Radio Bearer id

Definition at line 1143 of file lte-enb-rrc.cc.

References m_drbMap, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

void ns3::UeManager::ScheduleRrcConnectionReconfiguration ( )
void ns3::UeManager::SendUeContextRelease ( )

send the UE CONTEXT RELEASE X2 message to the source eNB, thus successfully terminating an X2 handover procedure

Definition at line 721 of file lte-enb-rrc.cc.

References CONNECTED_NORMALLY, HANDOVER_PATH_SWITCH, m_imsi, m_rnti, m_rrc, m_sourceCellId, m_sourceX2apId, m_state, ns3::EpcX2Sap::UeContextReleaseParams::newEnbUeX2apId, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::EpcX2Sap::UeContextReleaseParams::oldEnbUeX2apId, ns3::EpcX2Sap::UeContextReleaseParams::sourceCellId, SwitchToState(), and ns3::ToString().

+ Here is the call graph for this function:

void ns3::UeManager::SetImsi ( uint64_t  imsi)

Set the IMSI.

Parameters
imsithe IMSI

Definition at line 325 of file lte-enb-rrc.cc.

References m_imsi.

void ns3::UeManager::SetPdschConfigDedicated ( LteRrcSap::PdschConfigDedicated  pdschConfigDedicated)

Configure PdschConfigDedicated (i.e.

P_A value) for UE and start RrcConnectionReconfiguration to inform UE about new PdschConfigDedicated

Parameters
pdschConfigDedicatednew pdschConfigDedicated (i.e. P_A value) to be set

Definition at line 1096 of file lte-enb-rrc.cc.

References m_needPhyMacConfiguration, m_physicalConfigDedicated, NS_LOG_FUNCTION, ns3::LteRrcSap::PhysicalConfigDedicated::pdschConfigDedicated, and ScheduleRrcConnectionReconfiguration().

+ Here is the call graph for this function:

void ns3::UeManager::SetSource ( uint16_t  sourceCellId,
uint16_t  sourceX2apId 
)

Set the identifiers of the source eNB for the case where a UE joins the current eNB as part of a handover procedure.

Parameters
sourceCellId
sourceX2apId

Definition at line 318 of file lte-enb-rrc.cc.

References m_sourceCellId, and m_sourceX2apId.

void ns3::UeManager::SetSrsConfigurationIndex ( uint16_t  srsConfIndex)

Set the SRS configuration index and do the necessary reconfiguration.

Parameters
srsConfIndex

Definition at line 1071 of file lte-enb-rrc.cc.

References INITIAL_RANDOM_ACCESS, m_physicalConfigDedicated, m_rnti, m_rrc, m_state, NS_LOG_FUNCTION, ScheduleRrcConnectionReconfiguration(), ns3::LteRrcSap::PhysicalConfigDedicated::soundingRsUlConfigDedicated, and ns3::LteRrcSap::SoundingRsUlConfigDedicated::srsConfigIndex.

+ Here is the call graph for this function:

void ns3::UeManager::SetupDataRadioBearer ( EpsBearer  bearer,
uint8_t  bearerId,
uint32_t  gtpTeid,
Ipv4Address  transportLayerAddress 
)

Setup a new data radio bearer, including both the configuration within the eNB and the necessary RRC signaling with the UE.

Parameters
bearerthe QoS characteristics of the bearer
bearerIdthe EPS bearer identifier
gtpTeidS1-bearer GTP tunnel endpoint identifier, see 36.423 9.2.1
transportLayerAddressIP Address of the SGW, see 36.423 9.2.1

Definition at line 331 of file lte-enb-rrc.cc.

References AddDataRadioBearerInfo(), ns3::LteRrcSap::RlcConfig::AM, ns3::ObjectFactory::Create(), ns3::LteEnbRrc::X2uTeidInfo::drbid, Drbid2Bid(), Drbid2Lcid(), ns3::GbrQosInformation::gbrDl, ns3::LteEnbCmacSapProvider::LcInfo::gbrDl, ns3::EpsBearer::gbrQosInfo, ns3::GbrQosInformation::gbrUl, ns3::LteEnbCmacSapProvider::LcInfo::gbrUl, ns3::LteRlc::GetLteMacSapUser(), ns3::LteRlc::GetLteRlcSapProvider(), ns3::Object::GetObject(), ns3::LteRlcAm::GetTypeId(), ns3::LteRlcSm::GetTypeId(), HANDOVER_JOINING, ns3::LteEnbCmacSapProvider::LcInfo::isGbr, ns3::EpsBearer::IsGbr(), ns3::LteEnbCmacSapProvider::LcInfo::lcGroup, ns3::LteEnbCmacSapProvider::LcInfo::lcId, m_drbPdcpSapUser, m_rnti, m_rrc, m_state, ns3::GbrQosInformation::mbrDl, ns3::LteEnbCmacSapProvider::LcInfo::mbrDl, ns3::GbrQosInformation::mbrUl, ns3::LteEnbCmacSapProvider::LcInfo::mbrUl, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::LteEnbCmacSapProvider::LcInfo::qci, ns3::EpsBearer::qci, ns3::LteEnbCmacSapProvider::LcInfo::rnti, ns3::LteEnbRrc::X2uTeidInfo::rnti, ScheduleRrcConnectionReconfiguration(), ns3::LteRlc::SetLcId(), ns3::LteRlc::SetLteMacSapProvider(), ns3::LteRlc::SetLteRlcSapUser(), ns3::LteRlc::SetRnti(), ns3::ObjectFactory::SetTypeId(), and ns3::LteRrcSap::RlcConfig::UM_BI_DIRECTIONAL.

+ Here is the call graph for this function:

void ns3::UeManager::StartDataRadioBearers ( )

Start the data radio bearers that have been previously recorded to be started using RecordDataRadioBearersToBeStarted()

Definition at line 432 of file lte-enb-rrc.cc.

References m_drbMap, m_drbsToBeStarted, m_rnti, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by RecvRrcConnectionReconfigurationCompleted(), and RecvRrcConnectionSetupCompleted().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class LtePdcpSpecificLtePdcpSapUser< UeManager >
friend

Definition at line 64 of file lte-enb-rrc.h.

Member Data Documentation

EventId ns3::UeManager::m_connectionRejectedTimeout
private

The delay before a connection rejected timeout occurs.

Set after an RRC CONNECTION REJECT is sent. Calling LteEnbRrc::ConnectionRejectedTimeout() when it expires.

Definition at line 484 of file lte-enb-rrc.h.

Referenced by RecvRrcConnectionRequest().

EventId ns3::UeManager::m_connectionRequestTimeout
private

Time limit before a connection request timeout occurs.

Set after a new UE context is added after a successful Random Access. Calling LteEnbRrc::ConnectionRequestTimeout() when it expires. Cancelled when RRC CONNECTION REQUEST is received.

Definition at line 472 of file lte-enb-rrc.h.

Referenced by DoInitialize(), and RecvRrcConnectionRequest().

EventId ns3::UeManager::m_connectionSetupTimeout
private

Time limit before a connection setup timeout occurs.

Set after an RRC CONNECTION SETUP is sent. Calling LteEnbRrc::ConnectionSetupTimeout() when it expires. Cancelled when RRC CONNECTION SETUP COMPLETE is received.

Definition at line 478 of file lte-enb-rrc.h.

Referenced by RecvRrcConnectionRequest(), and RecvRrcConnectionSetupCompleted().

LtePdcpSapUser* ns3::UeManager::m_drbPdcpSapUser
private

Definition at line 449 of file lte-enb-rrc.h.

Referenced by DoDispose(), DoInitialize(), and SetupDataRadioBearer().

std::list<uint8_t> ns3::UeManager::m_drbsToBeStarted
private

Definition at line 463 of file lte-enb-rrc.h.

Referenced by RecordDataRadioBearersToBeStarted(), and StartDataRadioBearers().

EventId ns3::UeManager::m_handoverJoiningTimeout
private

Time limit before a handover joining timeout occurs.

Set after a new UE context is added after receiving a handover request. Calling LteEnbRrc::HandoverJoiningTimeout() when it expires. Cancelled when RRC CONNECTION RECONFIGURATION COMPLETE is received.

Definition at line 491 of file lte-enb-rrc.h.

Referenced by DoInitialize(), and RecvRrcConnectionReconfigurationCompleted().

EventId ns3::UeManager::m_handoverLeavingTimeout
private

Time limit before a handover leaving timeout occurs.

Set after a handover command is sent. Calling LteEnbRrc::HandoverLeavingTimeout() when it expires. Cancelled when RRC CONNECTION RE-ESTABLISHMENT or X2 UE CONTEXT RELEASE is received.

Definition at line 498 of file lte-enb-rrc.h.

Referenced by RecvHandoverRequestAck(), RecvRrcConnectionReestablishmentRequest(), and RecvUeContextRelease().

uint64_t ns3::UeManager::m_imsi
private

International Mobile Subscriber Identity assigned to this UE.

A globally unique UE identifier.

Definition at line 439 of file lte-enb-rrc.h.

Referenced by GetImsi(), PrepareHandover(), RecvHandoverRequestAck(), RecvMeasurementReport(), RecvRrcConnectionReconfigurationCompleted(), RecvRrcConnectionRequest(), RecvRrcConnectionSetupCompleted(), SendUeContextRelease(), SetImsi(), and SwitchToState().

uint8_t ns3::UeManager::m_lastAllocatedDrbid
private

Definition at line 414 of file lte-enb-rrc.h.

Referenced by AddDataRadioBearerInfo().

uint8_t ns3::UeManager::m_lastRrcTransactionIdentifier
private

Definition at line 441 of file lte-enb-rrc.h.

Referenced by GetNewRrcTransactionIdentifier().

bool ns3::UeManager::m_needPhyMacConfiguration
private
bool ns3::UeManager::m_pendingRrcConnectionReconfiguration
private

Definition at line 451 of file lte-enb-rrc.h.

Referenced by ScheduleRrcConnectionReconfiguration(), and SwitchToState().

uint16_t ns3::UeManager::m_sourceCellId
private

Definition at line 461 of file lte-enb-rrc.h.

Referenced by SendUeContextRelease(), and SetSource().

uint16_t ns3::UeManager::m_sourceX2apId
private

Definition at line 460 of file lte-enb-rrc.h.

Referenced by SendUeContextRelease(), and SetSource().

Ptr<LteSignalingRadioBearerInfo> ns3::UeManager::m_srb0
private

The Srb0 attribute.

SignalingRadioBearerInfo for SRB0.

Definition at line 425 of file lte-enb-rrc.h.

Referenced by CompleteSetupUe(), DoInitialize(), and GetTypeId().

Ptr<LteSignalingRadioBearerInfo> ns3::UeManager::m_srb1
private

The Srb1 attribute.

SignalingRadioBearerInfo for SRB1.

Definition at line 429 of file lte-enb-rrc.h.

Referenced by BuildRadioResourceConfigDedicated(), CompleteSetupUe(), DoInitialize(), and GetTypeId().

TracedCallback<uint64_t, uint16_t, uint16_t, State, State> ns3::UeManager::m_stateTransitionTrace
private

The StateTransition trace source.

Fired upon every UE state transition seen by the UeManager at the eNB RRC. Exporting IMSI, cell ID, RNTI, old state, and new state.

Definition at line 458 of file lte-enb-rrc.h.

Referenced by GetTypeId(), and SwitchToState().

uint16_t ns3::UeManager::m_targetCellId
private

Definition at line 462 of file lte-enb-rrc.h.

Referenced by PrepareHandover(), RecvHandoverPreparationFailure(), and SendData().


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