RlcUmRxEntityBase.h Source File¶

Simu5G: RlcUmRxEntityBase.h Source File
Simu5G
//
//                  Simu5G
//
// Authors: Giovanni Nardini, Giovanni Stea, Antonio Virdis (University of Pisa), Andras Varga (OpenSim Ltd)
//
// This file is part of a software released under the license included in file
// "license.pdf". Please read LICENSE and README files before using it.
// The above files and the present reference are part of the software itself,
// and cannot be removed from it.
//
 
#ifndef _SIMU5G_RLCUMRXENTITYBASE_H_
#define _SIMU5G_RLCUMRXENTITYBASE_H_
 
#include "simu5g/common/LteDefs.h"
#include "simu5g/stack/rlc/RlcRxEntityBase.h"
#include "simu5g/stack/rlc/LteRlcDefs.h"
 
namespace simu5g {
 
using namespace omnetpp;
 
class LteMacBase;
class RlcMux;
class RlcUmRxEntityBase : public RlcRxEntityBase
{
  protected:
 
    // Node id of the owner module
    MacNodeId ownerNodeId_;
 
    // The mux feeding this entity (for UL burst-throughput reporting)
    RlcMux *rlcMux_ = nullptr;
 
    // UL data-burst accounting (TS 136.314), eNB only
    enum BurstCheck { ENQUE, REORDERING };
    bool isBurst_ = false;
    unsigned int totalBits_ = 0;
    unsigned int ttiBits_ = 0;
    simtime_t t1_ = 0;
    simtime_t t2_ = 0;
 
    // Signals. Declared/registered in one translation unit (RlcUmRxEntityBase.cc),
    // in their historical order, so registerSignal() ordering -- and therefore result
    // recording -- is unaffected by the split. Emitted by the concrete subclasses.
    static simsignal_t rlcDelaySignal_[2];
    static simsignal_t rlcThroughputSignal_[2];
    static simsignal_t rlcPduDelaySignal_[2];
    static simsignal_t rlcPduThroughputSignal_[2];
    static simsignal_t receivedPacketFromLowerLayerSignal_;
    static simsignal_t sentPacketToUpperLayerSignal_;
 
    void initialize(int stage) override;
 
    // UL throughput burst accounting (shared accumulator; per-mode buffer-empty check
    // via isEmpty()).
    virtual void handleBurst(BurstCheck event);
 
    // --- mode-specific hooks, implemented by the concrete subclasses ---
 
    // Mode-specific INITSTAGE_LOCAL init (buffers, timers, window, rlcMux_ lookup).
    virtual void initMode(LteMacBase *mac) = 0;
 
  public:
 
    // Enqueues a lower-layer PDU into the entity for reassembly
    virtual void enque(cPacket *pkt) = 0;
 
    // returns true if the entity contains no buffered RLC data
    virtual bool isEmpty() const = 0;
};
 
} //namespace
 
#endif