A Discrete-Event Network Simulator
API
lte-ue-cmac-sap.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 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: Nicola Baldo <nbaldo@cttc.es>
18  */
19 
20 #ifndef LTE_UE_CMAC_SAP_H
21 #define LTE_UE_CMAC_SAP_H
22 
23 #include <ns3/eps-bearer.h>
24 #include <ns3/ff-mac-common.h>
25 #include <ns3/lte-common.h>
26 #include <ns3/packet.h>
27 
28 namespace ns3
29 {
30 
31 class LteMacSapUser;
32 
40 {
41  public:
42  virtual ~LteUeCmacSapProvider();
43 
45  struct RachConfig
46  {
48  uint8_t preambleTransMax;
50  uint8_t connEstFailCount;
51  };
52 
58  virtual void ConfigureRach(RachConfig rc) = 0;
59 
66 
76  uint8_t rapId,
77  uint8_t prachMask) = 0;
78 
81  {
82  uint8_t priority;
86  };
87 
95  virtual void AddLc(uint8_t lcId, LogicalChannelConfig lcConfig, LteMacSapUser* msu) = 0;
96 
102  virtual void RemoveLc(uint8_t lcId) = 0;
103 
108  virtual void Reset() = 0;
109 
114  virtual void SetRnti(uint16_t rnti) = 0;
115 
120  virtual void NotifyConnectionSuccessful() = 0;
121 
126  virtual void SetImsi(uint64_t imsi) = 0;
127 };
128 
136 {
137  public:
138  virtual ~LteUeCmacSapUser();
139 
145  virtual void SetTemporaryCellRnti(uint16_t rnti) = 0;
146 
151  virtual void NotifyRandomAccessSuccessful() = 0;
152 
157  virtual void NotifyRandomAccessFailed() = 0;
158 };
159 
160 } // namespace ns3
161 
162 #endif // LTE_UE_CMAC_SAP_H
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:96
Service Access Point (SAP) offered by the UE MAC to the UE RRC.
virtual void NotifyConnectionSuccessful()=0
Notify MAC about the successful RRC connection establishment.
virtual void SetRnti(uint16_t rnti)=0
virtual void RemoveLc(uint8_t lcId)=0
remove an existing LC
virtual void AddLc(uint8_t lcId, LogicalChannelConfig lcConfig, LteMacSapUser *msu)=0
add a new Logical Channel (LC)
virtual void SetImsi(uint64_t imsi)=0
A method call by UE RRC to communicate the IMSI to the UE MAC.
virtual void ConfigureRach(RachConfig rc)=0
Configure RACH function.
virtual void StartContentionBasedRandomAccessProcedure()=0
tell the MAC to start a contention-based random access procedure, e.g., to perform RRC connection est...
virtual void StartNonContentionBasedRandomAccessProcedure(uint16_t rnti, uint8_t rapId, uint8_t prachMask)=0
tell the MAC to start a non-contention-based random access procedure, e.g., as a consequence of hando...
virtual void Reset()=0
reset the MAC
Service Access Point (SAP) offered by the UE MAC to the UE RRC.
virtual void NotifyRandomAccessFailed()=0
Notify the RRC that the MAC Random Access procedure failed.
virtual void NotifyRandomAccessSuccessful()=0
Notify the RRC that the MAC Random Access procedure completed successfully.
virtual void SetTemporaryCellRnti(uint16_t rnti)=0
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint16_t prioritizedBitRateKbps
prioritize bit rate Kbps
uint16_t bucketSizeDurationMs
bucket size duration ms
uint8_t logicalChannelGroup
logical channel group
uint8_t raResponseWindowSize
RA response window size.
uint8_t connEstFailCount
the counter value for T300 timer expiration
uint8_t preambleTransMax
preamble transmit maximum
uint8_t numberOfRaPreambles
number of RA preambles