A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lte-mac-sap.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_MAC_SAP_H
22 #define LTE_MAC_SAP_H
23 
24 #include <ns3/packet.h>
25 
26 namespace ns3 {
27 
28 
29 
37 {
38 public:
39  virtual ~LteMacSapProvider ();
40 
46  {
48  uint16_t rnti;
49  uint8_t lcid;
50  uint8_t layer;
51  uint8_t harqProcessId;
52  };
53 
58  virtual void TransmitPdu (TransmitPduParameters params) = 0;
59 
60 
67  {
68  uint16_t rnti;
69  uint8_t lcid;
70  uint32_t txQueueSize;
71  uint16_t txQueueHolDelay;
72  uint32_t retxQueueSize;
73  uint16_t retxQueueHolDelay;
74  uint16_t statusPduSize;
75  };
76 
82  virtual void ReportBufferStatus (ReportBufferStatusParameters params) = 0;
83 
84 
85 };
86 
87 
95 {
96 public:
97  virtual ~LteMacSapUser ();
105  virtual void NotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId) = 0;
106 
113  virtual void NotifyHarqDeliveryFailure () = 0;
114 
115 
121  virtual void ReceivePdu (Ptr<Packet> p) = 0;
122 
123 };
124 
126 
127 template <class C>
129 {
130 public:
132 
133  // inherited from LteMacSapProvider
134  virtual void TransmitPdu (TransmitPduParameters params);
135  virtual void ReportBufferStatus (ReportBufferStatusParameters params);
136 
137 private:
138  C* m_mac;
139 };
140 
141 
142 template <class C>
144  : m_mac (mac)
145 {
146 }
147 
148 template <class C>
150 {
151  m_mac->DoTransmitPdu (params);
152 }
153 
154 template <class C>
156 {
157  m_mac->DoReportBufferStatus (params);
158 }
159 
160 
161 } // namespace ns3
162 
163 
164 #endif // LTE_MAC_SAP_H
virtual void NotifyHarqDeliveryFailure()=0
Called by the MAC to notify the RLC that an HARQ process related to this RLC instance has failed...
virtual void NotifyTxOpportunity(uint32_t bytes, uint8_t layer, uint8_t harqId)=0
Called by the MAC to notify the RLC that the scheduler granted a transmission opportunity to this RLC...
uint32_t retxQueueSize
the current size of the RLC retransmission queue in bytes
Definition: lte-mac-sap.h:72
virtual void ReportBufferStatus(ReportBufferStatusParameters params)
Report the RLC buffer status to the MAC.
Definition: lte-mac-sap.h:155
uint8_t lcid
the logical channel id corresponding to the sending RLC instance
Definition: lte-mac-sap.h:49
uint16_t rnti
the C-RNTI identifying the UE
Definition: lte-mac-sap.h:68
Parameters for LteMacSapProvider::ReportBufferStatus.
Definition: lte-mac-sap.h:66
uint16_t txQueueHolDelay
the Head Of Line delay of the transmission queue
Definition: lte-mac-sap.h:71
virtual void TransmitPdu(TransmitPduParameters params)
send an RLC PDU to the MAC for transmission.
Definition: lte-mac-sap.h:149
uint16_t rnti
the C-RNTI identifying the UE
Definition: lte-mac-sap.h:48
uint8_t layer
the layer value that was passed by the MAC in the call to NotifyTxOpportunity that generated this PDU...
Definition: lte-mac-sap.h:50
uint8_t lcid
the logical channel id corresponding to the sending RLC instance
Definition: lte-mac-sap.h:69
uint32_t txQueueSize
the current size of the RLC transmission queue
Definition: lte-mac-sap.h:70
uint16_t statusPduSize
the current size of the pending STATUS RLC PDU message in bytes
Definition: lte-mac-sap.h:74
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:94
uint16_t retxQueueHolDelay
the Head Of Line delay of the retransmission queue
Definition: lte-mac-sap.h:73
virtual void ReceivePdu(Ptr< Packet > p)=0
Called by the MAC to notify the RLC of the reception of a new PDU.
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:36
virtual void ReportBufferStatus(ReportBufferStatusParameters params)=0
Report the RLC buffer status to the MAC.
virtual ~LteMacSapUser()
Definition: lte-mac-sap.cc:32
uint8_t harqProcessId
the HARQ process id that was passed by the MAC in the call to NotifyTxOpportunity that generated this...
Definition: lte-mac-sap.h:51
virtual void TransmitPdu(TransmitPduParameters params)=0
send an RLC PDU to the MAC for transmission.
virtual ~LteMacSapProvider()
Definition: lte-mac-sap.cc:28
Parameters for LteMacSapProvider::TransmitPdu.
Definition: lte-mac-sap.h:45