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

This class implements the Access Stratum (AS) Service Access Point (SAP), i.e., the interface between the EpcUeNas and the LteUeRrc. More...

#include "lte-as-sap.h"

+ Inheritance diagram for ns3::LteAsSapProvider:

Public Member Functions

virtual ~LteAsSapProvider ()
 
virtual void Connect (void)=0
 Tell the RRC entity to enter Connected mode. More...
 
virtual void Disconnect ()=0
 Tell the RRC entity to release the connection. More...
 
virtual void ForceCampedOnEnb (uint16_t cellId, uint32_t dlEarfcn)=0
 Force the RRC entity to stay camped on a certain eNodeB. More...
 
virtual void SendData (Ptr< Packet > packet, uint8_t bid)=0
 Send a data packet. More...
 
virtual void SetCsgWhiteList (uint32_t csgId)=0
 Set the selected Closed Subscriber Group subscription list to be used for cell selection. More...
 
virtual void StartCellSelection (uint32_t dlEarfcn)=0
 Initiate Idle mode cell selection procedure. More...
 

Detailed Description

This class implements the Access Stratum (AS) Service Access Point (SAP), i.e., the interface between the EpcUeNas and the LteUeRrc.

In particular, this class implements the Provider part of the SAP, i.e., the methods exported by the LteUeRrc and called by the EpcUeNas.

Definition at line 39 of file lte-as-sap.h.

Constructor & Destructor Documentation

◆ ~LteAsSapProvider()

ns3::LteAsSapProvider::~LteAsSapProvider ( )
virtual

Definition at line 25 of file lte-as-sap.cc.

Member Function Documentation

◆ Connect()

virtual void ns3::LteAsSapProvider::Connect ( void  )
pure virtual

Tell the RRC entity to enter Connected mode.

If this function is called when the UE is in a situation where connecting is not possible (e.g. before the simulation begin), then the UE will attempt to connect at the earliest possible time (e.g. after it camps to a suitable cell).

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::Connect(), and ns3::EpcUeNas::DoNotifyConnectionFailed().

+ Here is the caller graph for this function:

◆ Disconnect()

virtual void ns3::LteAsSapProvider::Disconnect ( )
pure virtual

Tell the RRC entity to release the connection.

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::Disconnect().

+ Here is the caller graph for this function:

◆ ForceCampedOnEnb()

virtual void ns3::LteAsSapProvider::ForceCampedOnEnb ( uint16_t  cellId,
uint32_t  dlEarfcn 
)
pure virtual

Force the RRC entity to stay camped on a certain eNodeB.

Parameters
cellIdthe cell ID identifying the eNodeB
dlEarfcnthe downlink carrier frequency (EARFCN)

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::Connect().

+ Here is the caller graph for this function:

◆ SendData()

virtual void ns3::LteAsSapProvider::SendData ( Ptr< Packet packet,
uint8_t  bid 
)
pure virtual

Send a data packet.

Parameters
packetthe packet
bidthe EPS bearer ID

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::Send().

+ Here is the caller graph for this function:

◆ SetCsgWhiteList()

virtual void ns3::LteAsSapProvider::SetCsgWhiteList ( uint32_t  csgId)
pure virtual

Set the selected Closed Subscriber Group subscription list to be used for cell selection.

Parameters
csgIdidentity of the subscribed CSG

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::SetCsgId().

+ Here is the caller graph for this function:

◆ StartCellSelection()

virtual void ns3::LteAsSapProvider::StartCellSelection ( uint32_t  dlEarfcn)
pure virtual

Initiate Idle mode cell selection procedure.

Parameters
dlEarfcnthe downlink carrier frequency (EARFCN)

Implemented in ns3::MemberLteAsSapProvider< C >.

Referenced by ns3::EpcUeNas::StartCellSelection().

+ Here is the caller graph for this function:

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