A Discrete-Event Network Simulator
API
lte-rlc.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 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  * Author: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 #ifndef LTE_RLC_H
22 #define LTE_RLC_H
23 
24 #include <ns3/simple-ref-count.h>
25 #include <ns3/packet.h>
26 #include "ns3/uinteger.h"
27 #include "ns3/traced-value.h"
28 #include "ns3/trace-source-accessor.h"
29 #include "ns3/nstime.h"
30 
31 #include "ns3/object.h"
32 
33 #include "ns3/lte-rlc-sap.h"
34 #include "ns3/lte-mac-sap.h"
35 
36 namespace ns3 {
37 
38 
39 // class LteRlcSapProvider;
40 // class LteRlcSapUser;
41 //
42 // class LteMacSapProvider;
43 // class LteMacSapUser;
44 
50 class LteRlc : public Object // SimpleRefCount<LteRlc>
51 {
56 public:
57  LteRlc ();
58  virtual ~LteRlc ();
63  static TypeId GetTypeId (void);
64  virtual void DoDispose ();
65 
71  void SetRnti (uint16_t rnti);
72 
78  void SetLcId (uint8_t lcId);
79 
86 
93 
100 
107 
108 
117  typedef void (* NotifyTxTracedCallback)
118  (uint16_t rnti, uint8_t lcid, uint32_t bytes);
119 
129  typedef void (* ReceiveTracedCallback)
130  (uint16_t rnti, uint8_t lcid, uint32_t bytes, uint64_t delay);
131 
133  // NB to avoid the use of multiple inheritance
134 
135 protected:
136  // Interface forwarded by LteRlcSapProvider
142  virtual void DoTransmitPdcpPdu (Ptr<Packet> p) = 0;
143 
146 
147  // Interface forwarded by LteMacSapUser
157  virtual void DoNotifyHarqDeliveryFailure () = 0;
164 
167 
168  uint16_t m_rnti;
169  uint8_t m_lcid;
170 
184 
185 };
186 
187 
188 
197 class LteRlcSm : public LteRlc
198 {
199 public:
200  LteRlcSm ();
201  virtual ~LteRlcSm ();
206  static TypeId GetTypeId (void);
207  virtual void DoInitialize ();
208  virtual void DoDispose ();
209 
210  virtual void DoTransmitPdcpPdu (Ptr<Packet> p);
212  virtual void DoNotifyHarqDeliveryFailure ();
213  virtual void DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams);
214 
215 
216 
217 private:
219  void ReportBufferStatus ();
220 
221 };
222 
223 
224 
225 
226 // /**
227 // * Implements LTE_RLC Transparent Mode (TM), see 3GPP TS 36.322
228 // *
229 // */
230 // class LteRlcTm : public LteRlc
231 // {
232 // public:
233 // virtual ~LteRlcTm ();
234 
235 // };
236 
237 
238 // /**
239 // * Implements LTE_RLC Unacknowledged Mode (UM), see 3GPP TS 36.322
240 // *
241 // */
242 // class LteRlcUm : public LteRlc
243 // {
244 // public:
245 // virtual ~LteRlcUm ();
246 
247 // };
248 
249 // /**
250 // * Implements LTE_RLC Acknowledged Mode (AM), see 3GPP TS 36.322
251 // *
252 // */
253 
254 // class LteRlcAm : public LteRlc
255 // {
256 // public:
257 // virtual ~LteRlcAm ();
258 // };
259 
260 
261 
262 
263 
264 } // namespace ns3
265 
266 #endif // LTE_RLC_H
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:37
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:96
This abstract base class defines the API to interact with the Radio Link Control (LTE_RLC) in LTE,...
Definition: lte-rlc.h:51
LteRlcSapUser * m_rlcSapUser
RLC SAP user.
Definition: lte-rlc.h:144
uint8_t m_lcid
LCID.
Definition: lte-rlc.h:169
virtual void DoNotifyTxOpportunity(LteMacSapUser::TxOpportunityParameters params)=0
Notify transmit opportunity.
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-rlc.cc:102
TracedCallback< Ptr< const Packet > > m_txDropTrace
The trace source fired when the RLC drops a packet before transmission.
Definition: lte-rlc.h:183
void(* ReceiveTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t bytes, uint64_t delay)
TracedCallback signature for.
Definition: lte-rlc.h:130
void(* NotifyTxTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t bytes)
TracedCallback signature for NotifyTxOpportunity events.
Definition: lte-rlc.h:118
uint16_t m_rnti
RNTI.
Definition: lte-rlc.h:168
TracedCallback< uint16_t, uint8_t, uint32_t, uint64_t > m_rxPdu
Used to inform of a PDU reception from the MAC SAP user.
Definition: lte-rlc.h:178
LteRlcSapProvider * m_rlcSapProvider
RLC SAP provider.
Definition: lte-rlc.h:145
LteMacSapUser * m_macSapUser
MAC SAP user.
Definition: lte-rlc.h:165
LteMacSapProvider * m_macSapProvider
MAC SAP provider.
Definition: lte-rlc.h:166
virtual void DoDispose()
Destructor implementation.
Definition: lte-rlc.cc:125
void SetLteRlcSapUser(LteRlcSapUser *s)
Definition: lte-rlc.cc:147
TracedCallback< uint16_t, uint8_t, uint32_t > m_txPdu
Used to inform of a PDU delivery to the MAC SAP provider.
Definition: lte-rlc.h:174
void SetRnti(uint16_t rnti)
Definition: lte-rlc.cc:133
virtual void DoNotifyHarqDeliveryFailure()=0
Notify HARQ delivery failure.
void SetLteMacSapProvider(LteMacSapProvider *s)
Definition: lte-rlc.cc:161
virtual void DoReceivePdu(LteMacSapUser::ReceivePduParameters params)=0
Receive PDU function.
virtual ~LteRlc()
Definition: lte-rlc.cc:97
LteMacSapUser * GetLteMacSapUser()
Definition: lte-rlc.cc:168
void SetLcId(uint8_t lcId)
Definition: lte-rlc.cc:140
virtual void DoTransmitPdcpPdu(Ptr< Packet > p)=0
Transmit PDCP PDU.
LteRlcSapProvider * GetLteRlcSapProvider()
Definition: lte-rlc.cc:154
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:68
LTE_RLC Saturation Mode (SM): simulation-specific mode used for experiments that do not need to consi...
Definition: lte-rlc.h:198
virtual void DoDispose()
Destructor implementation.
Definition: lte-rlc.cc:209
virtual void DoNotifyTxOpportunity(LteMacSapUser::TxOpportunityParameters txOpParams)
Notify transmit opportunity.
Definition: lte-rlc.cc:239
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-rlc.cc:191
virtual void DoTransmitPdcpPdu(Ptr< Packet > p)
Transmit PDCP PDU.
Definition: lte-rlc.cc:216
virtual void DoInitialize()
Initialize() implementation.
Definition: lte-rlc.cc:202
virtual void DoNotifyHarqDeliveryFailure()
Notify HARQ delivery failure.
Definition: lte-rlc.cc:270
virtual ~LteRlcSm()
Definition: lte-rlc.cc:185
virtual void DoReceivePdu(LteMacSapUser::ReceivePduParameters rxPduParams)
Receive PDU function.
Definition: lte-rlc.cc:222
void ReportBufferStatus()
Report buffer status.
Definition: lte-rlc.cc:276
LteRlcSpecificLteMacSapUser class.
Definition: lte-rlc.cc:37
LteRlcSpecificLteRlcSapProvider.
Definition: lte-rlc-sap.h:84
A base class which provides memory management and object aggregation.
Definition: object.h:88
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Parameters for LteMacSapUser::ReceivePdu.
Definition: lte-mac-sap.h:157
Parameters for LteMacSapUser::NotifyTxOpportunity.
Definition: lte-mac-sap.h:104