A Discrete-Event Network Simulator
API
ns3::LteUeCmacSapProvider Class Referenceabstract

Service Access Point (SAP) offered by the UE MAC to the UE RRC. More...

#include "lte-ue-cmac-sap.h"

+ Inheritance diagram for ns3::LteUeCmacSapProvider:

Classes

struct  LogicalChannelConfig
 LogicalChannelConfig structure. More...
 
struct  RachConfig
 RachConfig structure. More...
 

Public Member Functions

virtual ~LteUeCmacSapProvider ()
 
virtual void AddLc (uint8_t lcId, LogicalChannelConfig lcConfig, LteMacSapUser *msu)=0
 add a new Logical Channel (LC) More...
 
virtual void ConfigureRach (RachConfig rc)=0
 Configure RACH function. More...
 
virtual void NotifyConnectionSuccessful ()=0
 Notify MAC about the successful RRC connection establishment. More...
 
virtual void RemoveLc (uint8_t lcId)=0
 remove an existing LC More...
 
virtual void Reset ()=0
 reset the MAC More...
 
virtual void SetImsi (uint64_t imsi)=0
 A method call by UE RRC to communicate the IMSI to the UE MAC. More...
 
virtual void SetRnti (uint16_t rnti)=0
 
virtual void StartContentionBasedRandomAccessProcedure ()=0
 tell the MAC to start a contention-based random access procedure, e.g., to perform RRC connection establishment More...
 
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 handover More...
 

Detailed Description

Service Access Point (SAP) offered by the UE MAC to the UE RRC.

This is the MAC SAP Provider, i.e., the part of the SAP that contains the MAC methods called by the RRC

Definition at line 40 of file lte-ue-cmac-sap.h.

Constructor & Destructor Documentation

◆ ~LteUeCmacSapProvider()

ns3::LteUeCmacSapProvider::~LteUeCmacSapProvider ( )
virtual

Definition at line 28 of file lte-ue-cmac-sap.cc.

Member Function Documentation

◆ AddLc()

virtual void ns3::LteUeCmacSapProvider::AddLc ( uint8_t  lcId,
LogicalChannelConfig  lcConfig,
LteMacSapUser msu 
)
pure virtual

add a new Logical Channel (LC)

Parameters
lcIdthe ID of the LC
lcConfigthe LC configuration provided by the RRC
msuthe corresponding LteMacSapUser

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ ConfigureRach()

virtual void ns3::LteUeCmacSapProvider::ConfigureRach ( RachConfig  rc)
pure virtual

Configure RACH function.

Parameters
rcthe RACH config

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ NotifyConnectionSuccessful()

virtual void ns3::LteUeCmacSapProvider::NotifyConnectionSuccessful ( )
pure virtual

Notify MAC about the successful RRC connection establishment.

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ RemoveLc()

virtual void ns3::LteUeCmacSapProvider::RemoveLc ( uint8_t  lcId)
pure virtual

remove an existing LC

Parameters
lcId

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ Reset()

virtual void ns3::LteUeCmacSapProvider::Reset ( )
pure virtual

reset the MAC

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ SetImsi()

virtual void ns3::LteUeCmacSapProvider::SetImsi ( uint64_t  imsi)
pure virtual

A method call by UE RRC to communicate the IMSI to the UE MAC.

Parameters
imsithe IMSI of the UE

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ SetRnti()

virtual void ns3::LteUeCmacSapProvider::SetRnti ( uint16_t  rnti)
pure virtual
Parameters
rntithe cell-specific UE identifier

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ StartContentionBasedRandomAccessProcedure()

virtual void ns3::LteUeCmacSapProvider::StartContentionBasedRandomAccessProcedure ( )
pure virtual

tell the MAC to start a contention-based random access procedure, e.g., to perform RRC connection establishment

Implemented in ns3::UeMemberLteUeCmacSapProvider.

◆ StartNonContentionBasedRandomAccessProcedure()

virtual void ns3::LteUeCmacSapProvider::StartNonContentionBasedRandomAccessProcedure ( uint16_t  rnti,
uint8_t  rapId,
uint8_t  prachMask 
)
pure virtual

tell the MAC to start a non-contention-based random access procedure, e.g., as a consequence of handover

Parameters
rnti
rapIdRandom Access Preamble Identifier
prachMask

Implemented in ns3::UeMemberLteUeCmacSapProvider.


The documentation for this class was generated from the following files: