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

Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RRC PDUs and transmitting them over Signaling Radio Bearers using radio resources allocated by the LTE MAC scheduler. More...

#include "lte-rrc-protocol-real.h"

+ Inheritance diagram for ns3::LteEnbRrcProtocolReal:
+ Collaboration diagram for ns3::LteEnbRrcProtocolReal:

Public Member Functions

 LteEnbRrcProtocolReal ()
 
virtual ~LteEnbRrcProtocolReal ()
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
LteEnbRrcSapUserGetLteEnbRrcSapUser ()
 Get LTE ENB RRC SAP user function. More...
 
LteUeRrcSapProviderGetUeRrcSapProvider (uint16_t rnti)
 Get UE RRC SAP provider function. More...
 
void SetCellId (uint16_t cellId)
 Set cell ID function. More...
 
void SetLteEnbRrcSapProvider (LteEnbRrcSapProvider *p)
 Set LTE ENB RRC SAP provider function. More...
 
void SetUeRrcSapProvider (uint16_t rnti, LteUeRrcSapProvider *p)
 Set UE RRC SAP provider function. 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
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

LteRrcSap::RrcConnectionReconfiguration DoDecodeHandoverCommand (Ptr< Packet > p)
 Decode handover command function. More...
 
LteRrcSap::HandoverPreparationInfo DoDecodeHandoverPreparationInformation (Ptr< Packet > p)
 Decode handover preparation information function. More...
 
Ptr< PacketDoEncodeHandoverCommand (LteRrcSap::RrcConnectionReconfiguration msg)
 Encode handover command function. More...
 
Ptr< PacketDoEncodeHandoverPreparationInformation (LteRrcSap::HandoverPreparationInfo msg)
 Encode handover preparation information function. More...
 
void DoReceivePdcpPdu (uint16_t rnti, Ptr< Packet > p)
 Receive PDCP PDU function. More...
 
void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params)
 Receive PDCP SDU function. More...
 
void DoRemoveUe (uint16_t rnti)
 Remove UE function. More...
 
void DoSendRrcConnectionReconfiguration (uint16_t rnti, LteRrcSap::RrcConnectionReconfiguration msg)
 Send RRC connection reconfiguration function. More...
 
void DoSendRrcConnectionReestablishment (uint16_t rnti, LteRrcSap::RrcConnectionReestablishment msg)
 Send RRC connection reestabishment function. More...
 
void DoSendRrcConnectionReestablishmentReject (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentReject msg)
 Send RRC connection reestabishment reject function. More...
 
void DoSendRrcConnectionReject (uint16_t rnti, LteRrcSap::RrcConnectionReject msg)
 Send RRC connection reject function. More...
 
void DoSendRrcConnectionRelease (uint16_t rnti, LteRrcSap::RrcConnectionRelease msg)
 Send RRC connection release function. More...
 
void DoSendRrcConnectionSetup (uint16_t rnti, LteRrcSap::RrcConnectionSetup msg)
 Send RRC connection setup function. More...
 
void DoSendSystemInformation (uint16_t cellId, LteRrcSap::SystemInformation msg)
 Send system information function. More...
 
void DoSetupUe (uint16_t rnti, LteEnbRrcSapUser::SetupUeParameters params)
 Setup UE function. More...
 
void SendSystemInformation (uint16_t cellId, LteRrcSap::SystemInformation msg)
 Send system information function. More...
 

Private Attributes

uint16_t m_cellId
 the cell ID More...
 
std::map< uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParametersm_completeSetupUeParametersMap
 complete setup UE parameters map More...
 
LteEnbRrcSapProviderm_enbRrcSapProvider
 ENB RRC SAP provider. More...
 
std::map< uint16_t, LteUeRrcSapProvider * > m_enbRrcSapProviderMap
 ENB RRC SAP provider map. More...
 
LteEnbRrcSapUserm_enbRrcSapUser
 ENB RRC SAP user. More...
 
uint16_t m_rnti
 the RNTI More...
 
std::map< uint16_t, LteEnbRrcSapUser::SetupUeParametersm_setupUeParametersMap
 setup UE parameters map More...
 

Friends

class LtePdcpSpecificLtePdcpSapUser< LteEnbRrcProtocolReal >
 allow LtePdcpSpecificLtePdcpSapUser<LteEnbRrcProtocolReal> class friend access More...
 
class LteRlcSpecificLteRlcSapUser< LteEnbRrcProtocolReal >
 allow LteRlcSpecificLteRlcSapUser<LteEnbRrcProtocolReal> class friend access More...
 
class MemberLteEnbRrcSapUser< LteEnbRrcProtocolReal >
 allow MemberLteEnbRrcSapUser<LteEnbRrcProtocolReal> class friend access More...
 
class RealProtocolRlcSapUser
 allow RealProtocolRlcSapUser class friend access More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RRC PDUs and transmitting them over Signaling Radio Bearers using radio resources allocated by the LTE MAC scheduler.


Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 192 bytes (on a 64-bit architecture).

Definition at line 184 of file lte-rrc-protocol-real.h.

Constructor & Destructor Documentation

◆ LteEnbRrcProtocolReal()

ns3::LteEnbRrcProtocolReal::LteEnbRrcProtocolReal ( )

Definition at line 380 of file lte-rrc-protocol-real.cc.

References m_enbRrcSapUser, and NS_LOG_FUNCTION.

◆ ~LteEnbRrcProtocolReal()

ns3::LteEnbRrcProtocolReal::~LteEnbRrcProtocolReal ( )
virtual

Definition at line 387 of file lte-rrc-protocol-real.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDecodeHandoverCommand()

LteRrcSap::RrcConnectionReconfiguration ns3::LteEnbRrcProtocolReal::DoDecodeHandoverCommand ( Ptr< Packet p)
private

Decode handover command function.

Parameters
pthe packet
Returns
LteRrcSap::RrcConnectionReconfiguration

Definition at line 777 of file lte-rrc-protocol-real.cc.

References ns3::RrcConnectionReconfigurationHeader::GetMessage(), and ns3::Packet::RemoveHeader().

+ Here is the call graph for this function:

◆ DoDecodeHandoverPreparationInformation()

LteRrcSap::HandoverPreparationInfo ns3::LteEnbRrcProtocolReal::DoDecodeHandoverPreparationInformation ( Ptr< Packet p)
private

Decode handover preparation information function.

Parameters
pthe packet
Returns
LteRrcSap::HandoverPreparationInfo

Definition at line 758 of file lte-rrc-protocol-real.cc.

References ns3::HandoverPreparationInfoHeader::GetMessage(), and ns3::Packet::RemoveHeader().

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::LteEnbRrcProtocolReal::DoDispose ( void  )
virtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 393 of file lte-rrc-protocol-real.cc.

References m_completeSetupUeParametersMap, m_enbRrcSapUser, and NS_LOG_FUNCTION.

◆ DoEncodeHandoverCommand()

Ptr< Packet > ns3::LteEnbRrcProtocolReal::DoEncodeHandoverCommand ( LteRrcSap::RrcConnectionReconfiguration  msg)
private

Encode handover command function.

Parameters
msgLteRrcSap::RrcConnectionReconfiguration
Returns
the packet

Definition at line 767 of file lte-rrc-protocol-real.cc.

References ns3::Packet::AddHeader(), and ns3::RrcConnectionReconfigurationHeader::SetMessage().

+ Here is the call graph for this function:

◆ DoEncodeHandoverPreparationInformation()

Ptr< Packet > ns3::LteEnbRrcProtocolReal::DoEncodeHandoverPreparationInformation ( LteRrcSap::HandoverPreparationInfo  msg)
private

Encode handover preparation information function.

Parameters
msgLteRrcSap::HandoverPreparationInfo
Returns
the packet

Definition at line 747 of file lte-rrc-protocol-real.cc.

References ns3::Packet::AddHeader(), and ns3::HandoverPreparationInfoHeader::SetMessage().

+ Here is the call graph for this function:

◆ DoReceivePdcpPdu()

void ns3::LteEnbRrcProtocolReal::DoReceivePdcpPdu ( uint16_t  rnti,
Ptr< Packet p 
)
private

◆ DoReceivePdcpSdu()

◆ DoRemoveUe()

void ns3::LteEnbRrcProtocolReal::DoRemoveUe ( uint16_t  rnti)
private

Remove UE function.

Parameters
rntithe RNTI

Definition at line 519 of file lte-rrc-protocol-real.cc.

References m_completeSetupUeParametersMap, m_enbRrcSapProviderMap, m_setupUeParametersMap, NS_ASSERT, and NS_LOG_FUNCTION.

◆ DoSendRrcConnectionReconfiguration()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReconfiguration ( uint16_t  rnti,
LteRrcSap::RrcConnectionReconfiguration  msg 
)
private

◆ DoSendRrcConnectionReestablishment()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReestablishment ( uint16_t  rnti,
LteRrcSap::RrcConnectionReestablishment  msg 
)
private

◆ DoSendRrcConnectionReestablishmentReject()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReestablishmentReject ( uint16_t  rnti,
LteRrcSap::RrcConnectionReestablishmentReject  msg 
)
private

◆ DoSendRrcConnectionReject()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReject ( uint16_t  rnti,
LteRrcSap::RrcConnectionReject  msg 
)
private

◆ DoSendRrcConnectionRelease()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionRelease ( uint16_t  rnti,
LteRrcSap::RrcConnectionRelease  msg 
)
private

◆ DoSendRrcConnectionSetup()

void ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionSetup ( uint16_t  rnti,
LteRrcSap::RrcConnectionSetup  msg 
)
private

◆ DoSendSystemInformation()

void ns3::LteEnbRrcProtocolReal::DoSendSystemInformation ( uint16_t  cellId,
LteRrcSap::SystemInformation  msg 
)
private

◆ DoSetupUe()

◆ GetLteEnbRrcSapUser()

LteEnbRrcSapUser * ns3::LteEnbRrcProtocolReal::GetLteEnbRrcSapUser ( )

Get LTE ENB RRC SAP user function.

Returns
LteEnbRrcSapUser *

Definition at line 426 of file lte-rrc-protocol-real.cc.

References m_enbRrcSapUser.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 409 of file lte-rrc-protocol-real.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUeRrcSapProvider()

LteUeRrcSapProvider * ns3::LteEnbRrcProtocolReal::GetUeRrcSapProvider ( uint16_t  rnti)

Get UE RRC SAP provider function.

Parameters
rntithe RNTI
Returns
LteUeRrcSapProvider *

Definition at line 438 of file lte-rrc-protocol-real.cc.

References m_enbRrcSapProviderMap, and NS_ASSERT_MSG().

+ Here is the call graph for this function:

◆ SendSystemInformation()

void ns3::LteEnbRrcProtocolReal::SendSystemInformation ( uint16_t  cellId,
LteRrcSap::SystemInformation  msg 
)
private

Send system information function.

Parameters
cellIdcell ID
msgLteRrcSap::SystemInformation

◆ SetCellId()

void ns3::LteEnbRrcProtocolReal::SetCellId ( uint16_t  cellId)

Set cell ID function.

Parameters
cellIdthe cell ID

Definition at line 432 of file lte-rrc-protocol-real.cc.

References m_cellId.

◆ SetLteEnbRrcSapProvider()

void ns3::LteEnbRrcProtocolReal::SetLteEnbRrcSapProvider ( LteEnbRrcSapProvider p)

Set LTE ENB RRC SAP provider function.

Parameters
pLteEnbRrcSapProvider *

Definition at line 420 of file lte-rrc-protocol-real.cc.

References m_enbRrcSapProvider.

◆ SetUeRrcSapProvider()

void ns3::LteEnbRrcProtocolReal::SetUeRrcSapProvider ( uint16_t  rnti,
LteUeRrcSapProvider p 
)

Set UE RRC SAP provider function.

Parameters
rntithe RNTI
pLteUeRrcSapProvider *

Definition at line 447 of file lte-rrc-protocol-real.cc.

References m_cellId, m_enbRrcSapProviderMap, and NS_ASSERT_MSG().

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ LtePdcpSpecificLtePdcpSapUser< LteEnbRrcProtocolReal >

allow LtePdcpSpecificLtePdcpSapUser<LteEnbRrcProtocolReal> class friend access

Definition at line 189 of file lte-rrc-protocol-real.h.

◆ LteRlcSpecificLteRlcSapUser< LteEnbRrcProtocolReal >

allow LteRlcSpecificLteRlcSapUser<LteEnbRrcProtocolReal> class friend access

Definition at line 191 of file lte-rrc-protocol-real.h.

◆ MemberLteEnbRrcSapUser< LteEnbRrcProtocolReal >

allow MemberLteEnbRrcSapUser<LteEnbRrcProtocolReal> class friend access

Definition at line 187 of file lte-rrc-protocol-real.h.

◆ RealProtocolRlcSapUser

friend class RealProtocolRlcSapUser
friend

allow RealProtocolRlcSapUser class friend access

Definition at line 193 of file lte-rrc-protocol-real.h.

Referenced by DoSetupUe().

Member Data Documentation

◆ m_cellId

uint16_t ns3::LteEnbRrcProtocolReal::m_cellId
private

the cell ID

Definition at line 357 of file lte-rrc-protocol-real.h.

Referenced by SetCellId(), and SetUeRrcSapProvider().

◆ m_completeSetupUeParametersMap

std::map<uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParameters> ns3::LteEnbRrcProtocolReal::m_completeSetupUeParametersMap
private

complete setup UE parameters map

Definition at line 362 of file lte-rrc-protocol-real.h.

Referenced by DoDispose(), DoRemoveUe(), and DoSetupUe().

◆ m_enbRrcSapProvider

LteEnbRrcSapProvider* ns3::LteEnbRrcProtocolReal::m_enbRrcSapProvider
private

ENB RRC SAP provider.

Definition at line 358 of file lte-rrc-protocol-real.h.

Referenced by DoReceivePdcpPdu(), DoReceivePdcpSdu(), DoSetupUe(), and SetLteEnbRrcSapProvider().

◆ m_enbRrcSapProviderMap

std::map<uint16_t, LteUeRrcSapProvider*> ns3::LteEnbRrcProtocolReal::m_enbRrcSapProviderMap
private

ENB RRC SAP provider map.

Definition at line 360 of file lte-rrc-protocol-real.h.

Referenced by DoRemoveUe(), DoSetupUe(), GetUeRrcSapProvider(), and SetUeRrcSapProvider().

◆ m_enbRrcSapUser

LteEnbRrcSapUser* ns3::LteEnbRrcProtocolReal::m_enbRrcSapUser
private

ENB RRC SAP user.

Definition at line 359 of file lte-rrc-protocol-real.h.

Referenced by DoDispose(), GetLteEnbRrcSapUser(), and LteEnbRrcProtocolReal().

◆ m_rnti

uint16_t ns3::LteEnbRrcProtocolReal::m_rnti
private

the RNTI

Definition at line 356 of file lte-rrc-protocol-real.h.

◆ m_setupUeParametersMap


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