lte-rlc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Nicola Baldo <nbaldo@cttc.es>
 */
 
#ifndef LTE_RLC_H
#define LTE_RLC_H
 
#include "lte-mac-sap.h"
#include "lte-rlc-sap.h"
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/traced-value.h"
#include "ns3/uinteger.h"
#include <ns3/packet.h>
#include <ns3/simple-ref-count.h>
 
namespace ns3
{
 
// class LteRlcSapProvider;
// class LteRlcSapUser;
//
// class LteMacSapProvider;
// class LteMacSapUser;
 
class LteRlc : public Object // SimpleRefCount<LteRlc>
{
    friend class LteRlcSpecificLteMacSapUser;
    friend class LteRlcSpecificLteRlcSapProvider<LteRlc>;
 
  public:
    LteRlc();
    ~LteRlc() override;
    static TypeId GetTypeId();
    void DoDispose() override;
 
    void SetRnti(uint16_t rnti);
 
    void SetLcId(uint8_t lcId);
 
    void SetPacketDelayBudgetMs(uint16_t packetDelayBudget);
 
    void SetLteRlcSapUser(LteRlcSapUser* s);
 
    LteRlcSapProvider* GetLteRlcSapProvider();
 
    void SetLteMacSapProvider(LteMacSapProvider* s);
 
    LteMacSapUser* GetLteMacSapUser();
 
    typedef void (*NotifyTxTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t bytes);
 
    typedef void (*ReceiveTracedCallback)(uint16_t rnti,
                                          uint8_t lcid,
                                          uint32_t bytes,
                                          uint64_t delay);
 
    // NB to avoid the use of multiple inheritance
 
  protected:
    // Interface forwarded by LteRlcSapProvider
    virtual void DoTransmitPdcpPdu(Ptr<Packet> p) = 0;
 
    LteRlcSapUser* m_rlcSapUser;         
    LteRlcSapProvider* m_rlcSapProvider; 
 
    // Interface forwarded by LteMacSapUser
    virtual void DoNotifyTxOpportunity(LteMacSapUser::TxOpportunityParameters params) = 0;
    virtual void DoNotifyHarqDeliveryFailure() = 0;
    virtual void DoReceivePdu(LteMacSapUser::ReceivePduParameters params) = 0;
 
    LteMacSapUser* m_macSapUser;         
    LteMacSapProvider* m_macSapProvider; 
 
    uint16_t m_rnti; 
    uint8_t m_lcid;  
    uint16_t m_packetDelayBudgetMs{
        UINT16_MAX}; 
 
    TracedCallback<uint16_t, uint8_t, uint32_t> m_txPdu;
    TracedCallback<uint16_t, uint8_t, uint32_t, uint64_t> m_rxPdu;
    TracedCallback<Ptr<const Packet>> m_txDropTrace;
};
 
class LteRlcSm : public LteRlc
{
  public:
    LteRlcSm();
    ~LteRlcSm() override;
    static TypeId GetTypeId();
    void DoInitialize() override;
    void DoDispose() override;
 
    void DoTransmitPdcpPdu(Ptr<Packet> p) override;
    void DoNotifyTxOpportunity(LteMacSapUser::TxOpportunityParameters txOpParams) override;
    void DoNotifyHarqDeliveryFailure() override;
    void DoReceivePdu(LteMacSapUser::ReceivePduParameters rxPduParams) override;
 
  private:
    void ReportBufferStatus();
};
 
// /**
//  * Implements LTE_RLC Transparent Mode (TM), see  3GPP TS 36.322
//  *
//  */
// class LteRlcTm : public LteRlc
// {
// public:
//   virtual ~LteRlcTm ();
 
// };
 
// /**
//  * Implements LTE_RLC Unacknowledged Mode (UM), see  3GPP TS 36.322
//  *
//  */
// class LteRlcUm : public LteRlc
// {
// public:
//   virtual ~LteRlcUm ();
 
// };
 
// /**
//  * Implements LTE_RLC Acknowledged Mode (AM), see  3GPP TS 36.322
//  *
//  */
 
// class LteRlcAm : public LteRlc
// {
// public:
//   virtual ~LteRlcAm ();
// };
 
} // namespace ns3
 
#endif // LTE_RLC_H