A Discrete-Event Network Simulator
API
lte-rrc-protocol-real.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Nicola Baldo <nbaldo@cttc.es>
19  * Lluis Parcerisa <lparcerisa@cttc.cat>
20  */
21 
22 
23 #ifndef LTE_RRC_PROTOCOL_REAL_H
24 #define LTE_RRC_PROTOCOL_REAL_H
25 
26 #include <stdint.h>
27 #include <map>
28 
29 #include <ns3/ptr.h>
30 #include <ns3/object.h>
31 #include <ns3/lte-rrc-sap.h>
32 #include <ns3/lte-pdcp-sap.h>
33 #include <ns3/lte-rlc-sap.h>
34 #include <ns3/lte-rrc-header.h>
35 
36 namespace ns3 {
37 
39 class LteUeRrcSapUser;
41 class LteUeRrc;
42 
43 
54 {
61 
62 public:
64  virtual ~LteUeRrcProtocolReal ();
65 
66  // inherited from Object
67  virtual void DoDispose (void);
72  static TypeId GetTypeId (void);
73 
86 
92  void SetUeRrc (Ptr<LteUeRrc> rrc);
93 
94 
95 private:
96  // methods forwarded from LteUeRrcSapUser
148  void DoSendIdealUeContextRemoveRequest (uint16_t rnti);
149 
151  void SetEnbRrcSapProvider ();
157  void DoReceivePdcpPdu (Ptr<Packet> p);
164 
166  uint16_t m_rnti;
170 
173 
174 };
175 
176 
185 {
194 
195 public:
197  virtual ~LteEnbRrcProtocolReal ();
198 
199  // inherited from Object
200  virtual void DoDispose (void);
205  static TypeId GetTypeId (void);
206 
219 
225  void SetCellId (uint16_t cellId);
226 
233  LteUeRrcSapProvider* GetUeRrcSapProvider (uint16_t rnti);
240  void SetUeRrcSapProvider (uint16_t rnti, LteUeRrcSapProvider* p);
241 
242 private:
243  // methods forwarded from LteEnbRrcSapUser
250  void DoSetupUe (uint16_t rnti, LteEnbRrcSapUser::SetupUeParameters params);
256  void DoRemoveUe (uint16_t rnti);
263  void DoSendSystemInformation (uint16_t cellId, LteRrcSap::SystemInformation msg);
341 
354  void DoReceivePdcpPdu (uint16_t rnti, Ptr<Packet> p);
355 
356  uint16_t m_rnti;
357  uint16_t m_cellId;
360  std::map<uint16_t, LteUeRrcSapProvider*> m_enbRrcSapProviderMap;
361  std::map<uint16_t, LteEnbRrcSapUser::SetupUeParameters> m_setupUeParametersMap;
362  std::map<uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParameters> m_completeSetupUeParametersMap;
363 
364 };
365 
366 
369 {
370 public:
377  RealProtocolRlcSapUser (LteEnbRrcProtocolReal* pdcp, uint16_t rnti);
378 
379  // Interface implemented from LteRlcSapUser
380  virtual void ReceivePdcpPdu (Ptr<Packet> p);
381 
382 private:
385  uint16_t m_rnti;
386 };
387 
388 
389 }
390 
391 
392 #endif // LTE_RRC_PROTOCOL_REAL_H
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::LteUeRrcProtocolReal::DoSendIdealUeContextRemoveRequest
void DoSendIdealUeContextRemoveRequest(uint16_t rnti)
Send ideal UE context remove request function.
Definition: lte-rrc-protocol-real.cc:197
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReestablishmentReject
void DoSendRrcConnectionReestablishmentReject(uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentReject msg)
Send RRC connection reestabishment reject function.
Definition: lte-rrc-protocol-real.cc:640
ns3::LteEnbRrcProtocolReal::SetUeRrcSapProvider
void SetUeRrcSapProvider(uint16_t rnti, LteUeRrcSapProvider *p)
Set UE RRC SAP provider function.
Definition: lte-rrc-protocol-real.cc:447
ns3::LteEnbRrcProtocolReal
Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RR...
Definition: lte-rrc-protocol-real.h:185
ns3::LteEnbRrcSapUser::SetupUeParameters
SetupUeParameters structure.
Definition: lte-rrc-sap.h:1086
ns3::LteRrcSap::RrcConnectionSetupCompleted
RrcConnectionSetupCompleted structure.
Definition: lte-rrc-sap.h:706
ns3::LteRrcSap::RrcConnectionRelease
RrcConnectionRelease structure.
Definition: lte-rrc-sap.h:884
ns3::LteUeRrcSapProvider
Part of the RRC protocol.
Definition: lte-rrc-sap.h:1001
ns3::LteUeRrcSapUser
Part of the RRC protocol.
Definition: lte-rrc-sap.h:917
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LteUeRrcProtocolReal::m_completeSetupParameters
LteUeRrcSapProvider::CompleteSetupParameters m_completeSetupParameters
complete setup parameters
Definition: lte-rrc-protocol-real.h:172
ns3::LteEnbRrcProtocolReal::m_rnti
uint16_t m_rnti
the RNTI
Definition: lte-rrc-protocol-real.h:356
ns3::LteUeRrcProtocolReal::GetLteUeRrcSapUser
LteUeRrcSapUser * GetLteUeRrcSapUser()
Get LTE UE RRC SAP user function.
Definition: lte-rrc-protocol-real.cc:85
ns3::LteEnbRrcProtocolReal::m_enbRrcSapUser
LteEnbRrcSapUser * m_enbRrcSapUser
ENB RRC SAP user.
Definition: lte-rrc-protocol-real.h:359
ns3::LteRrcSap::SystemInformation
SystemInformation structure.
Definition: lte-rrc-sap.h:609
ns3::RealProtocolRlcSapUser::RealProtocolRlcSapUser
RealProtocolRlcSapUser()
Definition: lte-rrc-protocol-real.cc:796
ns3::LtePdcpSpecificLtePdcpSapUser
LtePdcpSpecificLtePdcpSapUser class.
Definition: lte-pdcp-sap.h:134
ns3::LteUeRrcProtocolReal::m_enbRrcSapProvider
LteEnbRrcSapProvider * m_enbRrcSapProvider
ENB RRC SAP provider.
Definition: lte-rrc-protocol-real.h:169
ns3::LteEnbRrcProtocolReal::m_enbRrcSapProvider
LteEnbRrcSapProvider * m_enbRrcSapProvider
ENB RRC SAP provider.
Definition: lte-rrc-protocol-real.h:358
ns3::LteUeRrcProtocolReal::~LteUeRrcProtocolReal
virtual ~LteUeRrcProtocolReal()
Definition: lte-rrc-protocol-real.cc:53
ns3::LteEnbRrcProtocolReal::GetLteEnbRrcSapUser
LteEnbRrcSapUser * GetLteEnbRrcSapUser()
Get LTE ENB RRC SAP user function.
Definition: lte-rrc-protocol-real.cc:426
ns3::LteUeRrcSapProvider::CompleteSetupParameters
CompleteSetupParameters structure.
Definition: lte-rrc-sap.h:1005
ns3::LteUeRrc
Definition: lte-ue-rrc.h:82
ns3::LteRrcSap::RrcConnectionReconfigurationCompleted
RrcConnectionReconfigurationCompleted structure.
Definition: lte-rrc-sap.h:852
ns3::RealProtocolRlcSapUser::m_rnti
uint16_t m_rnti
RNTI.
Definition: lte-rrc-protocol-real.h:385
ns3::LteRrcSap::RrcConnectionReject
RrcConnectionReject structure.
Definition: lte-rrc-sap.h:890
ns3::LteRrcSap::HandoverPreparationInfo
HandoverPreparationInfo structure.
Definition: lte-rrc-sap.h:896
ns3::LteRrcSap::RrcConnectionSetup
RrcConnectionSetup structure.
Definition: lte-rrc-sap.h:699
ns3::LtePdcpSapUser::ReceivePdcpSduParameters
Parameters for LtePdcpSapUser::ReceivePdcpSdu.
Definition: lte-pdcp-sap.h:78
ns3::LteUeRrcProtocolReal::m_ueRrcSapProvider
LteUeRrcSapProvider * m_ueRrcSapProvider
UE RRC SAP provider.
Definition: lte-rrc-protocol-real.h:167
ns3::LteEnbRrcProtocolReal::LteEnbRrcProtocolReal
LteEnbRrcProtocolReal()
Definition: lte-rrc-protocol-real.cc:380
ns3::LteEnbRrcProtocolReal::DoReceivePdcpPdu
void DoReceivePdcpPdu(uint16_t rnti, Ptr< Packet > p)
Receive PDCP PDU function.
Definition: lte-rrc-protocol-real.cc:676
ns3::LteUeRrcProtocolReal::m_rrc
Ptr< LteUeRrc > m_rrc
the RRC
Definition: lte-rrc-protocol-real.h:165
ns3::LteUeRrcProtocolReal::DoSendRrcConnectionReestablishmentComplete
void DoSendRrcConnectionReestablishmentComplete(LteRrcSap::RrcConnectionReestablishmentComplete msg)
Send RRC connection reestablishment complete function.
Definition: lte-rrc-protocol-real.cc:236
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReject
void DoSendRrcConnectionReject(uint16_t rnti, LteRrcSap::RrcConnectionReject msg)
Send RRC connection reject function.
Definition: lte-rrc-protocol-real.cc:586
ns3::LteRlcSpecificLteRlcSapUser
LteRlcSpecificLteRlcSapUser class.
Definition: lte-rlc-sap.h:125
ns3::LteEnbRrcProtocolReal::SetCellId
void SetCellId(uint16_t cellId)
Set cell ID function.
Definition: lte-rrc-protocol-real.cc:432
ns3::LteEnbRrcProtocolReal::m_setupUeParametersMap
std::map< uint16_t, LteEnbRrcSapUser::SetupUeParameters > m_setupUeParametersMap
setup UE parameters map
Definition: lte-rrc-protocol-real.h:361
ns3::LteUeRrcProtocolReal::DoSendRrcConnectionReconfigurationCompleted
void DoSendRrcConnectionReconfigurationCompleted(LteRrcSap::RrcConnectionReconfigurationCompleted msg)
Send RRC connection reconfiguration setup completed function.
Definition: lte-rrc-protocol-real.cc:151
ns3::LteEnbRrcProtocolReal::m_cellId
uint16_t m_cellId
the cell ID
Definition: lte-rrc-protocol-real.h:357
ns3::LteEnbRrcProtocolReal::DoDispose
virtual void DoDispose(void)
Destructor implementation.
Definition: lte-rrc-protocol-real.cc:393
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::LteEnbRrcProtocolReal::m_enbRrcSapProviderMap
std::map< uint16_t, LteUeRrcSapProvider * > m_enbRrcSapProviderMap
ENB RRC SAP provider map.
Definition: lte-rrc-protocol-real.h:360
ns3::MemberLteUeRrcSapUser
Template for the implementation of the LteUeRrcSapUser as a member of an owner class of type C to whi...
Definition: lte-rrc-sap.h:1306
ns3::LteUeRrcProtocolReal::DoReceivePdcpSdu
void DoReceivePdcpSdu(LtePdcpSapUser::ReceivePdcpSduParameters params)
Receive PDCP SDU function.
Definition: lte-rrc-protocol-real.cc:348
ns3::LteEnbRrcProtocolReal::SetLteEnbRrcSapProvider
void SetLteEnbRrcSapProvider(LteEnbRrcSapProvider *p)
Set LTE ENB RRC SAP provider function.
Definition: lte-rrc-protocol-real.cc:420
ns3::LteEnbRrcProtocolReal::m_completeSetupUeParametersMap
std::map< uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParameters > m_completeSetupUeParametersMap
complete setup UE parameters map
Definition: lte-rrc-protocol-real.h:362
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::RealProtocolRlcSapUser::m_pdcp
LteEnbRrcProtocolReal * m_pdcp
PDCP.
Definition: lte-rrc-protocol-real.h:384
ns3::LteRrcSap::RrcConnectionRequest
RrcConnectionRequest structure.
Definition: lte-rrc-sap.h:693
ns3::LteRrcSap::RrcConnectionReestablishmentReject
RrcConnectionReestablishmentReject structure.
Definition: lte-rrc-sap.h:879
ns3::LteEnbRrcProtocolReal::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-rrc-protocol-real.cc:409
ns3::LteUeRrcProtocolReal::m_ueRrcSapUser
LteUeRrcSapUser * m_ueRrcSapUser
UE RRC SAP user.
Definition: lte-rrc-protocol-real.h:168
ns3::LteEnbRrcProtocolReal::DoDecodeHandoverPreparationInformation
LteRrcSap::HandoverPreparationInfo DoDecodeHandoverPreparationInformation(Ptr< Packet > p)
Decode handover preparation information function.
Definition: lte-rrc-protocol-real.cc:761
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionRelease
void DoSendRrcConnectionRelease(uint16_t rnti, LteRrcSap::RrcConnectionRelease msg)
Send RRC connection release function.
Definition: lte-rrc-protocol-real.cc:658
ns3::MemberLteEnbRrcSapUser
Template for the implementation of the LteEnbRrcSapUser as a member of an owner class of type C to wh...
Definition: lte-rrc-sap.h:1503
ns3::LteUeRrcProtocolReal::DoSendMeasurementReport
void DoSendMeasurementReport(LteRrcSap::MeasurementReport msg)
Send measurement report function.
Definition: lte-rrc-protocol-real.cc:174
ns3::LteEnbRrcProtocolReal::DoReceivePdcpSdu
void DoReceivePdcpSdu(LtePdcpSapUser::ReceivePdcpSduParameters params)
Receive PDCP SDU function.
Definition: lte-rrc-protocol-real.cc:705
ns3::LteRrcSap::RrcConnectionReestablishment
RrcConnectionReestablishment structure.
Definition: lte-rrc-sap.h:866
ns3::LteUeRrcProtocolReal::SetUeRrc
void SetUeRrc(Ptr< LteUeRrc > rrc)
Set UE RRC function.
Definition: lte-rrc-protocol-real.cc:91
ns3::LteUeRrcProtocolReal::m_setupParameters
LteUeRrcSapUser::SetupParameters m_setupParameters
setup parameters
Definition: lte-rrc-protocol-real.h:171
ns3::LteEnbRrcSapProvider
Part of the RRC protocol.
Definition: lte-rrc-sap.h:1201
ns3::LteEnbRrcProtocolReal::DoSetupUe
void DoSetupUe(uint16_t rnti, LteEnbRrcSapUser::SetupUeParameters params)
Setup UE function.
Definition: lte-rrc-protocol-real.cc:460
ns3::LteUeRrcProtocolReal::DoSetup
void DoSetup(LteUeRrcSapUser::SetupParameters params)
Setup function.
Definition: lte-rrc-protocol-real.cc:97
ns3::LteRrcSap::RrcConnectionReestablishmentRequest
RrcConnectionReestablishmentRequest structure.
Definition: lte-rrc-sap.h:859
ns3::LteRrcSap::MeasurementReport
MeasurementReport structure.
Definition: lte-rrc-sap.h:902
ns3::LteEnbRrcProtocolReal::~LteEnbRrcProtocolReal
virtual ~LteEnbRrcProtocolReal()
Definition: lte-rrc-protocol-real.cc:387
ns3::LteEnbRrcProtocolReal::SendSystemInformation
void SendSystemInformation(uint16_t cellId, LteRrcSap::SystemInformation msg)
Send system information function.
ns3::LteUeRrcProtocolReal::DoDispose
virtual void DoDispose(void)
Destructor implementation.
Definition: lte-rrc-protocol-real.cc:58
ns3::LteEnbRrcSapUser
Part of the RRC protocol.
Definition: lte-rrc-sap.h:1082
ns3::RealProtocolRlcSapUser::ReceivePdcpPdu
virtual void ReceivePdcpPdu(Ptr< Packet > p)
Called by the RLC entity to notify the PDCP entity of the reception of a new PDCP PDU.
Definition: lte-rrc-protocol-real.cc:801
ns3::LteUeRrcProtocolReal::DoReceivePdcpPdu
void DoReceivePdcpPdu(Ptr< Packet > p)
Receive PDCP PDU function.
Definition: lte-rrc-protocol-real.cc:299
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionSetup
void DoSendRrcConnectionSetup(uint16_t rnti, LteRrcSap::RrcConnectionSetup msg)
Send RRC connection setup function.
Definition: lte-rrc-protocol-real.cc:568
ns3::LteUeRrcSapUser::SetupParameters
SetupParameters structure.
Definition: lte-rrc-sap.h:921
ns3::LteUeRrcProtocolReal::SetEnbRrcSapProvider
void SetEnbRrcSapProvider()
Set ENB RRC SAP provider.
Definition: lte-rrc-protocol-real.cc:255
ns3::LteUeRrcProtocolReal::SetLteUeRrcSapProvider
void SetLteUeRrcSapProvider(LteUeRrcSapProvider *p)
Set LTE UE RRC SAP provider function.
Definition: lte-rrc-protocol-real.cc:79
ns3::LteUeRrcProtocolReal::LteUeRrcProtocolReal
LteUeRrcProtocolReal()
Definition: lte-rrc-protocol-real.cc:44
ns3::LteUeRrcProtocolReal::DoSendRrcConnectionReestablishmentRequest
void DoSendRrcConnectionReestablishmentRequest(LteRrcSap::RrcConnectionReestablishmentRequest msg)
Send RRC connection reestablishment request function.
Definition: lte-rrc-protocol-real.cc:218
ns3::LteRrcSap::RrcConnectionReconfiguration
RrcConnectionReconfiguration structure.
Definition: lte-rrc-sap.h:837
ns3::LteUeRrcProtocolReal::DoSendRrcConnectionRequest
void DoSendRrcConnectionRequest(LteRrcSap::RrcConnectionRequest msg)
Send RRC connection request function.
Definition: lte-rrc-protocol-real.cc:107
ns3::LteEnbRrcProtocolReal::DoSendSystemInformation
void DoSendSystemInformation(uint16_t cellId, LteRrcSap::SystemInformation msg)
Send system information function.
Definition: lte-rrc-protocol-real.cc:536
ns3::LteUeRrcProtocolReal
Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RR...
Definition: lte-rrc-protocol-real.h:54
ns3::LteEnbRrcProtocolReal::DoEncodeHandoverCommand
Ptr< Packet > DoEncodeHandoverCommand(LteRrcSap::RrcConnectionReconfiguration msg)
Encode handover command function.
Definition: lte-rrc-protocol-real.cc:770
ns3::LteEnbRrcProtocolReal::DoDecodeHandoverCommand
LteRrcSap::RrcConnectionReconfiguration DoDecodeHandoverCommand(Ptr< Packet > p)
Decode handover command function.
Definition: lte-rrc-protocol-real.cc:780
ns3::LteEnbRrcProtocolReal::DoRemoveUe
void DoRemoveUe(uint16_t rnti)
Remove UE function.
Definition: lte-rrc-protocol-real.cc:522
ns3::LteEnbRrcProtocolReal::DoEncodeHandoverPreparationInformation
Ptr< Packet > DoEncodeHandoverPreparationInformation(LteRrcSap::HandoverPreparationInfo msg)
Encode handover preparation information function.
Definition: lte-rrc-protocol-real.cc:750
ns3::LteUeRrcProtocolReal::DoSendRrcConnectionSetupCompleted
void DoSendRrcConnectionSetupCompleted(LteRrcSap::RrcConnectionSetupCompleted msg)
Send RRC connection setup completed function.
Definition: lte-rrc-protocol-real.cc:130
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReconfiguration
void DoSendRrcConnectionReconfiguration(uint16_t rnti, LteRrcSap::RrcConnectionReconfiguration msg)
Send RRC connection reconfiguration function.
Definition: lte-rrc-protocol-real.cc:604
ns3::LteEnbRrcProtocolReal::GetUeRrcSapProvider
LteUeRrcSapProvider * GetUeRrcSapProvider(uint16_t rnti)
Get UE RRC SAP provider function.
Definition: lte-rrc-protocol-real.cc:438
ns3::LteUeRrcProtocolReal::m_rnti
uint16_t m_rnti
the RNTI
Definition: lte-rrc-protocol-real.h:166
ns3::RealProtocolRlcSapUser
RealProtocolRlcSapUser class.
Definition: lte-rrc-protocol-real.h:369
ns3::LteRrcSap::RrcConnectionReestablishmentComplete
RrcConnectionReestablishmentComplete structure.
Definition: lte-rrc-sap.h:873
ns3::LteEnbRrcProtocolReal::DoSendRrcConnectionReestablishment
void DoSendRrcConnectionReestablishment(uint16_t rnti, LteRrcSap::RrcConnectionReestablishment msg)
Send RRC connection reestabishment function.
Definition: lte-rrc-protocol-real.cc:622
ns3::LteUeRrcProtocolReal::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-rrc-protocol-real.cc:68
ns3::LteRlcSapUser
Service Access Point (SAP) offered by the UM-RLC and AM-RLC entities to the PDCP entity See 3GPP 36....
Definition: lte-rlc-sap.h:68