A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lte-rlc-am.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: Manuel Requena <manuel.requena@cttc.es>
19  */
20 
21 #ifndef LTE_RLC_AM_H
22 #define LTE_RLC_AM_H
23 
24 #include <ns3/event-id.h>
25 #include <ns3/lte-rlc-sequence-number.h>
26 #include <ns3/lte-rlc.h>
27 
28 #include <vector>
29 #include <map>
30 
31 namespace ns3 {
32 
36 class LteRlcAm : public LteRlc
37 {
38 public:
39  LteRlcAm ();
40  virtual ~LteRlcAm ();
41  static TypeId GetTypeId (void);
42  virtual void DoDispose ();
43 
47  virtual void DoTransmitPdcpPdu (Ptr<Packet> p);
48 
52  virtual void DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId);
53  virtual void DoNotifyHarqDeliveryFailure ();
54  virtual void DoReceivePdu (Ptr<Packet> p);
55 
56 private:
62  void ExpireReorderingTimer (void);
63  void ExpirePollRetransmitTimer (void);
64 
66 //
67 // void ReassembleOutsideWindow (void);
68 // void ReassembleSnLessThan (uint16_t seqNumber);
69 //
70  void ReassembleAndDeliver (Ptr<Packet> packet);
71 
72  void DoReportBufferStatus ();
73 
74 private:
75  std::vector < Ptr<Packet> > m_txonBuffer; // Transmission buffer
76  std::vector < Ptr<Packet> > m_txedBuffer; // Transmitted packets buffer
77 
78  struct RetxBuffer
79  {
81  uint16_t m_retxCount;
82  };
83 
84  std::vector < RetxBuffer > m_retxBuffer; // Retransmission buffer
85 
86  uint32_t m_txonBufferSize;
87  uint32_t m_retxBufferSize;
88  uint32_t m_txedBufferSize;
89 
92 
93  struct PduBuffer
94  {
96  std::list < Ptr<Packet> > m_byteSegments;
97 
99  uint16_t m_totalSize;
100  uint16_t m_currSize;
101  };
102 
103  std::map <uint16_t, PduBuffer > m_rxonBuffer; // Reception buffer
104 
105  Ptr<Packet> m_controlPduBuffer; // Control PDU buffer (just one PDU)
106 
107  // SDU reassembly
108 // std::vector < Ptr<Packet> > m_reasBuffer; // Reassembling buffer
109 //
110  std::list < Ptr<Packet> > m_sdusBuffer; // List of SDUs in a packet (PDU)
111 
115  // Transmitting side
120 
121  // Receiving side
127 
133 
137  uint16_t m_windowSize;
138 
146 
151  uint16_t m_pollPdu;
152  uint16_t m_pollByte;
153 
155 
159  typedef enum { NONE = 0,
164 
169 
170 };
171 
172 
173 } // namespace ns3
174 
175 #endif // LTE_RLC_AM_H
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
SequenceNumber10 m_seqNumber
Definition: lte-rlc-am.h:95
EventId m_statusProhibitTimer
Definition: lte-rlc-am.h:145
uint32_t m_byteWithoutPoll
Definition: lte-rlc-am.h:132
virtual void DoReceivePdu(Ptr< Packet > p)
Definition: lte-rlc-am.cc:628
std::vector< RetxBuffer > m_retxBuffer
Definition: lte-rlc-am.h:84
virtual void DoNotifyTxOpportunity(uint32_t bytes, uint8_t layer, uint8_t harqId)
MAC SAP.
Definition: lte-rlc-am.cc:167
uint32_t m_statusPduBufferSize
Definition: lte-rlc-am.h:91
SequenceNumber10 m_vtS
Definition: lte-rlc-am.h:118
void DoReportBufferStatus()
Definition: lte-rlc-am.cc:1550
SequenceNumber10 m_vtMs
Definition: lte-rlc-am.h:117
SequenceNumber10 m_vrMs
Definition: lte-rlc-am.h:125
Time m_pollRetransmitTimerValue
Definition: lte-rlc-am.h:143
SequenceNumber10 m_vrR
Definition: lte-rlc-am.h:122
EventId m_reorderingTimer
Definition: lte-rlc-am.h:144
ReassemblingState_t
SDU Reassembling state.
Definition: lte-rlc-am.h:159
bool IsInsideReceivingWindow(SequenceNumber10 seqNumber)
Definition: lte-rlc-am.cc:1055
EventId m_pollRetransmitTimer
Timers.
Definition: lte-rlc-am.h:142
uint32_t m_txonBufferSize
Definition: lte-rlc-am.h:86
SequenceNumber10 m_expectedSeqNumber
Expected Sequence Number.
Definition: lte-rlc-am.h:168
std::map< uint16_t, PduBuffer > m_rxonBuffer
Definition: lte-rlc-am.h:103
uint16_t m_pollPdu
Definition: lte-rlc-am.h:151
Ptr< Packet > m_keepS0
Definition: lte-rlc-am.h:163
SequenceNumber10 m_pollSn
Definition: lte-rlc-am.h:119
std::list< Ptr< Packet > > m_sdusBuffer
Definition: lte-rlc-am.h:110
uint16_t m_pollByte
Definition: lte-rlc-am.h:152
SequenceNumber10 m_vrH
Definition: lte-rlc-am.h:126
SequenceNumber10 m_vrMr
Definition: lte-rlc-am.h:123
SequenceNumber10 m_vrX
Definition: lte-rlc-am.h:124
uint32_t m_pduWithoutPoll
Counters.
Definition: lte-rlc-am.h:131
uint32_t m_txedBufferSize
Definition: lte-rlc-am.h:88
virtual void DoNotifyHarqDeliveryFailure()
Definition: lte-rlc-am.cc:622
uint16_t m_maxRetxThreshold
Configurable parameters.
Definition: lte-rlc-am.h:150
an identifier for simulation events.
Definition: event-id.h:46
virtual void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: lte-rlc-am.cc:109
void ExpirePollRetransmitTimer(void)
Definition: lte-rlc-am.cc:1654
SequenceNumber10 m_vtA
State variables.
Definition: lte-rlc-am.h:116
std::vector< Ptr< Packet > > m_txonBuffer
Definition: lte-rlc-am.h:75
LTE RLC Acknowledged Mode (AM), see 3GPP TS 36.322.
Definition: lte-rlc-am.h:36
Ptr< Packet > m_controlPduBuffer
Definition: lte-rlc-am.h:105
void ReassembleAndDeliver(Ptr< Packet > packet)
Definition: lte-rlc-am.cc:1079
std::list< Ptr< Packet > > m_byteSegments
Definition: lte-rlc-am.h:96
uint16_t m_windowSize
Constants.
Definition: lte-rlc-am.h:137
bool m_txOpportunityForRetxAlwaysBigEnough
Definition: lte-rlc-am.h:154
ReassemblingState_t m_reassemblingState
Definition: lte-rlc-am.h:162
This abstract base class defines the API to interact with the Radio Link Control (LTE_RLC) in LTE...
Definition: lte-rlc.h:50
a unique identifier for an interface.
Definition: type-id.h:49
uint32_t m_retxBufferSize
Definition: lte-rlc-am.h:87
static TypeId GetTypeId(void)
Definition: lte-rlc-am.cc:86
bool m_statusPduRequested
Definition: lte-rlc-am.h:90
void ExpireReorderingTimer(void)
This method will schedule a timeout at WaitReplyTimeout interval in the future, unless a timer is alr...
Definition: lte-rlc-am.cc:1617
std::vector< Ptr< Packet > > m_txedBuffer
Definition: lte-rlc-am.h:76
virtual void DoTransmitPdcpPdu(Ptr< Packet > p)
RLC SAP.
Definition: lte-rlc-am.cc:136
virtual ~LteRlcAm()
Definition: lte-rlc-am.cc:80