A Discrete-Event Network Simulator
API
lte-pdcp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Manuel Requena <manuel.requena@cttc.es>
18  */
19 
20 #ifndef LTE_PDCP_H
21 #define LTE_PDCP_H
22 
23 #include "lte-pdcp-sap.h"
24 #include "lte-rlc-sap.h"
25 
26 #include "ns3/object.h"
27 #include "ns3/trace-source-accessor.h"
28 #include "ns3/traced-value.h"
29 
30 namespace ns3
31 {
32 
36 class LtePdcp : public Object // SimpleRefCount<LtePdcp>
37 {
42 
43  public:
44  LtePdcp();
45  ~LtePdcp() override;
50  static TypeId GetTypeId();
51  void DoDispose() override;
52 
58  void SetRnti(uint16_t rnti);
59 
65  void SetLcId(uint8_t lcId);
66 
73 
80 
87 
94 
96  static const uint16_t MAX_PDCP_SN = 4096;
97 
101  struct Status
102  {
103  uint16_t txSn;
104  uint16_t rxSn;
105  };
106 
111  Status GetStatus() const;
112 
118  void SetStatus(Status s);
119 
128  typedef void (*PduTxTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t size);
129 
139  typedef void (*PduRxTracedCallback)(const uint16_t rnti,
140  const uint8_t lcid,
141  const uint32_t size,
142  const uint64_t delay);
143 
144  protected:
151 
154 
160  virtual void DoReceivePdu(Ptr<Packet> p);
161 
164 
165  uint16_t m_rnti;
166  uint8_t m_lcid;
167 
178 
179  private:
188 
192  static const uint16_t m_maxPdcpSn = 4095;
193 };
194 
195 } // namespace ns3
196 
197 #endif // LTE_PDCP_H
LTE PDCP entity, see 3GPP TS 36.323.
Definition: lte-pdcp.h:37
uint16_t m_rxSequenceNumber
State variables.
Definition: lte-pdcp.h:187
void SetLtePdcpSapUser(LtePdcpSapUser *s)
Definition: lte-pdcp.cc:130
void(* PduRxTracedCallback)(const uint16_t rnti, const uint8_t lcid, const uint32_t size, const uint64_t delay)
TracedCallback signature for PDU receive event.
Definition: lte-pdcp.h:139
LteRlcSapUser * GetLteRlcSapUser()
Definition: lte-pdcp.cc:151
static const uint16_t MAX_PDCP_SN
maximum PDCP SN
Definition: lte-pdcp.h:96
LtePdcpSapUser * m_pdcpSapUser
PDCP SAP user.
Definition: lte-pdcp.h:152
LtePdcpSapProvider * GetLtePdcpSapProvider()
Definition: lte-pdcp.cc:137
virtual void DoReceivePdu(Ptr< Packet > p)
Interface provided to lower RLC entity.
Definition: lte-pdcp.cc:209
LteRlcSapUser * m_rlcSapUser
RLC SAP user.
Definition: lte-pdcp.h:162
uint8_t m_lcid
LCID.
Definition: lte-pdcp.h:166
~LtePdcp() override
Definition: lte-pdcp.cc:85
uint16_t m_txSequenceNumber
State variables.
Definition: lte-pdcp.h:183
void SetStatus(Status s)
Set the status of the PDCP.
Definition: lte-pdcp.cc:167
virtual void DoTransmitPdcpSdu(LtePdcpSapProvider::TransmitPdcpSduParameters params)
Interface provided to upper RRC entity.
Definition: lte-pdcp.cc:176
LteRlcSapProvider * m_rlcSapProvider
RLC SAP provider.
Definition: lte-pdcp.h:163
TracedCallback< uint16_t, uint8_t, uint32_t, uint64_t > m_rxPdu
Used to inform of a PDU reception from the RLC SAP user.
Definition: lte-pdcp.h:177
static const uint16_t m_maxPdcpSn
Constants.
Definition: lte-pdcp.h:192
void SetRnti(uint16_t rnti)
Definition: lte-pdcp.cc:116
TracedCallback< uint16_t, uint8_t, uint32_t > m_txPdu
Used to inform of a PDU delivery to the RLC SAP provider.
Definition: lte-pdcp.h:172
void(* PduTxTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t size)
TracedCallback for PDU transmission event.
Definition: lte-pdcp.h:128
LtePdcpSapProvider * m_pdcpSapProvider
PDCP SAP provider.
Definition: lte-pdcp.h:153
Status GetStatus() const
Definition: lte-pdcp.cc:158
void SetLteRlcSapProvider(LteRlcSapProvider *s)
Definition: lte-pdcp.cc:144
void DoDispose() override
Destructor implementation.
Definition: lte-pdcp.cc:108
void SetLcId(uint8_t lcId)
Definition: lte-pdcp.cc:123
uint16_t m_rnti
RNTI.
Definition: lte-pdcp.h:165
static TypeId GetTypeId()
Get the type ID.
Definition: lte-pdcp.cc:91
Service Access Point (SAP) offered by the PDCP entity to the RRC entity See 3GPP 36....
Definition: lte-pdcp-sap.h:36
Service Access Point (SAP) offered by the PDCP entity to the RRC entity See 3GPP 36....
Definition: lte-pdcp-sap.h:69
LtePdcpSpecificLtePdcpSapProvider class.
Definition: lte-pdcp-sap.h:94
LtePdcpSpecificLteRlcSapUser class.
Definition: lte-pdcp.cc:36
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:36
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
A base class which provides memory management and object aggregation.
Definition: object.h:89
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
Status variables of the PDCP.
Definition: lte-pdcp.h:102
uint16_t rxSn
RX sequence number.
Definition: lte-pdcp.h:104
uint16_t txSn
TX sequence number.
Definition: lte-pdcp.h:103
Parameters for LtePdcpSapProvider::TransmitPdcpSdu.
Definition: lte-pdcp-sap.h:44