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 
38 class LteUeRrcSapProvider;
39 class LteUeRrcSapUser;
40 class LteEnbRrcSapProvider;
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
139 
141  void SetEnbRrcSapProvider ();
147  void DoReceivePdcpPdu (Ptr<Packet> p);
154 
156  uint16_t m_rnti;
160 
163 
164 };
165 
166 
175 {
184 
185 public:
187  virtual ~LteEnbRrcProtocolReal ();
188 
189  // inherited from Object
190  virtual void DoDispose (void);
195  static TypeId GetTypeId (void);
196 
209 
215  void SetCellId (uint16_t cellId);
216 
223  LteUeRrcSapProvider* GetUeRrcSapProvider (uint16_t rnti);
230  void SetUeRrcSapProvider (uint16_t rnti, LteUeRrcSapProvider* p);
231 
232 private:
233  // methods forwarded from LteEnbRrcSapUser
240  void DoSetupUe (uint16_t rnti, LteEnbRrcSapUser::SetupUeParameters params);
246  void DoRemoveUe (uint16_t rnti);
253  void DoSendSystemInformation (uint16_t cellId, LteRrcSap::SystemInformation msg);
260  void SendSystemInformation (uint16_t cellId, LteRrcSap::SystemInformation msg);
331 
344  void DoReceivePdcpPdu (uint16_t rnti, Ptr<Packet> p);
345 
346  uint16_t m_rnti;
347  uint16_t m_cellId;
350  std::map<uint16_t, LteUeRrcSapProvider*> m_enbRrcSapProviderMap;
351  std::map<uint16_t, LteEnbRrcSapUser::SetupUeParameters> m_setupUeParametersMap;
352  std::map<uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParameters> m_completeSetupUeParametersMap;
353 
354 };
355 
356 
359 {
360 public:
367  RealProtocolRlcSapUser (LteEnbRrcProtocolReal* pdcp, uint16_t rnti);
368 
369  // Interface implemented from LteRlcSapUser
370  virtual void ReceivePdcpPdu (Ptr<Packet> p);
371 
372 private:
375  uint16_t m_rnti;
376 };
377 
378 
379 }
380 
381 
382 #endif // LTE_RRC_PROTOCOL_REAL_H
virtual void DoDispose(void)
Destructor implementation.
RrcConnectionRequest structure.
Definition: lte-rrc-sap.h:685
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:67
virtual void ReceivePdcpPdu(Ptr< Packet > p)
Called by the RLC entity to notify the PDCP entity of the reception of a new PDCP PDU...
void DoSetup(LteUeRrcSapUser::SetupParameters params)
Setup function.
void DoSendMeasurementReport(LteRrcSap::MeasurementReport msg)
Send measurement report function.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Part of the RRC protocol.
Definition: lte-rrc-sap.h:982
LteUeRrcSapProvider * m_ueRrcSapProvider
UE RRC SAP provider.
MeasurementReport structure.
Definition: lte-rrc-sap.h:894
void DoSendRrcConnectionReject(uint16_t rnti, LteRrcSap::RrcConnectionReject msg)
Send RRC connection reject function.
RealProtocolRlcSapUser class.
virtual void DoDispose(void)
Destructor implementation.
void DoSendRrcConnectionRelease(uint16_t rnti, LteRrcSap::RrcConnectionRelease msg)
Send RRC connection release function.
LteRlcSpecificLteRlcSapUser class.
Definition: lte-rlc-sap.h:124
Part of the RRC protocol.
Definition: lte-rrc-sap.h:1182
Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RR...
static TypeId GetTypeId(void)
Get the type ID.
Template for the implementation of the LteEnbRrcSapUser as a member of an owner class of type C to wh...
Definition: lte-rrc-sap.h:1465
Ptr< Packet > DoEncodeHandoverCommand(LteRrcSap::RrcConnectionReconfiguration msg)
Encode handover command function.
LteUeRrcSapProvider::CompleteSetupParameters m_completeSetupParameters
complete setup parameters
LteRrcSap::RrcConnectionReconfiguration DoDecodeHandoverCommand(Ptr< Packet > p)
Decode handover command function.
Ptr< Packet > DoEncodeHandoverPreparationInformation(LteRrcSap::HandoverPreparationInfo msg)
Encode handover preparation information function.
SetupParameters structure.
Definition: lte-rrc-sap.h:913
LteUeRrcSapProvider * GetUeRrcSapProvider(uint16_t rnti)
Get UE RRC SAP provider function.
Models the transmission of RRC messages from the UE to the eNB in a real fashion, by creating real RR...
std::map< uint16_t, LteEnbRrcSapUser::SetupUeParameters > m_setupUeParametersMap
setup UE parameters map
std::map< uint16_t, LteUeRrcSapProvider * > m_enbRrcSapProviderMap
ENB RRC SAP provider map.
LteUeRrcSapUser * m_ueRrcSapUser
UE RRC SAP user.
SystemInformation structure.
Definition: lte-rrc-sap.h:601
Parameters for LtePdcpSapUser::ReceivePdcpSdu.
Definition: lte-pdcp-sap.h:76
void SetLteEnbRrcSapProvider(LteEnbRrcSapProvider *p)
Set LTE ENB RRC SAP provider function.
void DoSendRrcConnectionSetup(uint16_t rnti, LteRrcSap::RrcConnectionSetup msg)
Send RRC connection setup function.
void SetUeRrcSapProvider(uint16_t rnti, LteUeRrcSapProvider *p)
Set UE RRC SAP provider function.
RrcConnectionReestablishment structure.
Definition: lte-rrc-sap.h:858
void DoSendRrcConnectionReestablishmentRequest(LteRrcSap::RrcConnectionReestablishmentRequest msg)
Send RRC connection reestablishment request function.
std::map< uint16_t, LteEnbRrcSapProvider::CompleteSetupUeParameters > m_completeSetupUeParametersMap
complete setup UE parameters map
void DoReceivePdcpPdu(Ptr< Packet > p)
Receive PDCP PDU function.
RrcConnectionReconfiguration structure.
Definition: lte-rrc-sap.h:829
SetupUeParameters structure.
Definition: lte-rrc-sap.h:1067
RrcConnectionReconfigurationCompleted structure.
Definition: lte-rrc-sap.h:844
void SetEnbRrcSapProvider()
Set ENB RRC SAP provider.
LteEnbRrcSapUser * GetLteEnbRrcSapUser()
Get LTE ENB RRC SAP user function.
RrcConnectionSetupCompleted structure.
Definition: lte-rrc-sap.h:698
HandoverPreparationInfo structure.
Definition: lte-rrc-sap.h:888
RrcConnectionSetup structure.
Definition: lte-rrc-sap.h:691
RrcConnectionReestablishmentRequest structure.
Definition: lte-rrc-sap.h:851
void SendSystemInformation(uint16_t cellId, LteRrcSap::SystemInformation msg)
Send system information function.
Part of the RRC protocol.
Definition: lte-rrc-sap.h:1063
void DoSendRrcConnectionReestablishmentReject(uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentReject msg)
Send RRC connection reestabishment reject function.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
RrcConnectionReject structure.
Definition: lte-rrc-sap.h:882
Ptr< LteUeRrc > m_rrc
the RRC
void DoSendRrcConnectionReconfiguration(uint16_t rnti, LteRrcSap::RrcConnectionReconfiguration msg)
Send RRC connection reconfiguration function.
void DoSendRrcConnectionReestablishment(uint16_t rnti, LteRrcSap::RrcConnectionReestablishment msg)
Send RRC connection reestabishment function.
LtePdcpSpecificLtePdcpSapUser class.
Definition: lte-pdcp-sap.h:132
LteEnbRrcSapProvider * m_enbRrcSapProvider
ENB RRC SAP provider.
RrcConnectionReestablishmentReject structure.
Definition: lte-rrc-sap.h:871
void DoReceivePdcpSdu(LtePdcpSapUser::ReceivePdcpSduParameters params)
Receive PDCP SDU function.
void DoSendRrcConnectionReestablishmentComplete(LteRrcSap::RrcConnectionReestablishmentComplete msg)
Send RRC connection reestablishment complete function.
void DoSendRrcConnectionSetupCompleted(LteRrcSap::RrcConnectionSetupCompleted msg)
Send RRC connection setup completed function.
void DoSendRrcConnectionReconfigurationCompleted(LteRrcSap::RrcConnectionReconfigurationCompleted msg)
Send RRC connection reconfiguration setup completed function.
static TypeId GetTypeId(void)
Get the type ID.
LteUeRrcSapUser::SetupParameters m_setupParameters
setup parameters
void DoSendRrcConnectionRequest(LteRrcSap::RrcConnectionRequest msg)
Send RRC connection request function.
void DoReceivePdcpPdu(uint16_t rnti, Ptr< Packet > p)
Receive PDCP PDU function.
LteEnbRrcSapUser * m_enbRrcSapUser
ENB RRC SAP user.
RrcConnectionReestablishmentComplete structure.
Definition: lte-rrc-sap.h:865
LteRrcSap::HandoverPreparationInfo DoDecodeHandoverPreparationInformation(Ptr< Packet > p)
Decode handover preparation information function.
LteEnbRrcSapProvider * m_enbRrcSapProvider
ENB RRC SAP provider.
void DoReceivePdcpSdu(LtePdcpSapUser::ReceivePdcpSduParameters params)
Receive PDCP SDU function.
void SetCellId(uint16_t cellId)
Set cell ID function.
CompleteSetupParameters structure.
Definition: lte-rrc-sap.h:986
Template for the implementation of the LteUeRrcSapUser as a member of an owner class of type C to whi...
Definition: lte-rrc-sap.h:1276
A base class which provides memory management and object aggregation.
Definition: object.h:87
LteUeRrcSapUser * GetLteUeRrcSapUser()
Get LTE UE RRC SAP user function.
Part of the RRC protocol.
Definition: lte-rrc-sap.h:909
RrcConnectionRelease structure.
Definition: lte-rrc-sap.h:876
LteEnbRrcProtocolReal * m_pdcp
PDCP.
void SetLteUeRrcSapProvider(LteUeRrcSapProvider *p)
Set LTE UE RRC SAP provider function.
void DoSendSystemInformation(uint16_t cellId, LteRrcSap::SystemInformation msg)
Send system information function.
a unique identifier for an interface.
Definition: type-id.h:58
void DoSetupUe(uint16_t rnti, LteEnbRrcSapUser::SetupUeParameters params)
Setup UE function.
void DoRemoveUe(uint16_t rnti)
Remove UE function.
void SetUeRrc(Ptr< LteUeRrc > rrc)
Set UE RRC function.