A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::PointToPointEpcHelper Class Reference

Create an EPC network with PointToPoint links. More...

#include "point-to-point-epc-helper.h"

+ Inheritance diagram for ns3::PointToPointEpcHelper:

Public Member Functions

 PointToPointEpcHelper ()
 Constructor. More...
 
virtual ~PointToPointEpcHelper ()
 Destructor. More...
 
virtual uint8_t ActivateEpsBearer (Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer)
 Activate an EPS bearer, setting up the corresponding S1-U tunnel. More...
 
virtual void AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)
 Add an eNB to the EPC. More...
 
virtual void AddUe (Ptr< NetDevice > ueLteDevice, uint64_t imsi)
 Notify the EPC of the existence of a new UE which might attach at a later time. More...
 
virtual void AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)
 Add an X2 interface between two eNB. More...
 
virtual Ipv4InterfaceContainer AssignUeIpv4Address (NetDeviceContainer ueDevices)
 Assign IPv4 addresses to UE devices. More...
 
virtual Ipv6InterfaceContainer AssignUeIpv6Address (NetDeviceContainer ueDevices)
 Assign IPv6 addresses to UE devices. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
TypeId GetInstanceTypeId () const
 Get the most derived TypeId for this Object. More...
 
virtual Ptr< NodeGetPgwNode ()
 
virtual Ipv4Address GetUeDefaultGatewayAddress ()
 
virtual Ipv6Address GetUeDefaultGatewayAddress6 ()
 
- Public Member Functions inherited from ns3::EpcHelper
 EpcHelper ()
 Constructor. More...
 
virtual ~EpcHelper ()
 Destructor. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::EpcHelper
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

bool m_enablePcapOverS1U
 Enable PCAP generation for S1U link. More...
 
bool m_enablePcapOverX2
 Enable PCAP generation for X2 link. More...
 
uint16_t m_gtpuUdpPort
 UDP port where the GTP-U Socket is bound, fixed by the standard as 2152. More...
 
std::map< uint64_t, Ptr< NetDevice > > m_imsiEnbDeviceMap
 Map storing for each IMSI the corresponding eNB NetDevice. More...
 
Ptr< EpcMmem_mme
 MME network element. More...
 
Ipv4AddressHelper m_s1uIpv4AddressHelper
 S1-U interfaces. More...
 
DataRate m_s1uLinkDataRate
 The data rate to be used for the next S1-U link to be created. More...
 
Time m_s1uLinkDelay
 The delay to be used for the next S1-U link to be created. More...
 
uint16_t m_s1uLinkMtu
 The MTU of the next S1-U link to be created. More...
 
std::string m_s1uLinkPcapPrefix
 Prefix for the PCAP file for the S1 link. More...
 
Ptr< Nodem_sgwPgw
 SGW-PGW network element. More...
 
Ptr< EpcSgwPgwApplicationm_sgwPgwApp
 SGW-PGW application. More...
 
Ptr< VirtualNetDevicem_tunDevice
 TUN device implementing tunneling of user data over GTP-U/UDP/IP. More...
 
Ipv4AddressHelper m_uePgwAddressHelper
 helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW More...
 
Ipv6AddressHelper m_uePgwAddressHelper6
 helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW More...
 
Ipv4AddressHelper m_x2Ipv4AddressHelper
 helper to assign addresses to X2 NetDevices More...
 
DataRate m_x2LinkDataRate
 The data rate to be used for the next X2 link to be created. More...
 
Time m_x2LinkDelay
 The delay to be used for the next X2 link to be created. More...
 
uint16_t m_x2LinkMtu
 The MTU of the next X2 link to be created. More...
 
std::string m_x2LinkPcapPrefix
 Prefix for the PCAP file for the X2 link. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Create an EPC network with PointToPoint links.


Introspection did not find any typical Config paths.

This Helper will create an EPC network topology comprising of a single node that implements both the SGW and PGW functionality, and an MME node. The S1-U, X2-U and X2-C interfaces are realized over PointToPoint links.


Attributes

No TraceSources are defined for this type.
Size of this type is 328 bytes (on a 64-bit architecture).

Definition at line 52 of file point-to-point-epc-helper.h.

Constructor & Destructor Documentation

◆ PointToPointEpcHelper()

ns3::PointToPointEpcHelper::PointToPointEpcHelper ( )

◆ ~PointToPointEpcHelper()

ns3::PointToPointEpcHelper::~PointToPointEpcHelper ( )
virtual

Destructor.

Definition at line 136 of file point-to-point-epc-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ActivateEpsBearer()

uint8_t ns3::PointToPointEpcHelper::ActivateEpsBearer ( Ptr< NetDevice ueLteDevice,
uint64_t  imsi,
Ptr< EpcTft tft,
EpsBearer  bearer 
)
virtual

Activate an EPS bearer, setting up the corresponding S1-U tunnel.

Parameters
ueLteDevicethe Ipv4-enabled device of the UE, normally connected via the LTE radio interface
imsithe unique identifier of the UE
tftthe Traffic Flow Template of the new bearer
bearerstruct describing the characteristics of the EPS bearer to be activated
Returns
bearer ID

Implements ns3::EpcHelper.

Definition at line 373 of file point-to-point-epc-helper.cc.

References ns3::EpcUeNas::ActivateEpsBearer(), ns3::Object::GetObject(), m_mme, m_sgwPgwApp, NS_ASSERT_MSG(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::Simulator::ScheduleNow().

Referenced by EpcS1uDlTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

◆ AddEnb()

void ns3::PointToPointEpcHelper::AddEnb ( Ptr< Node enbNode,
Ptr< NetDevice lteEnbNetDevice,
uint16_t  cellId 
)
virtual

◆ AddUe()

void ns3::PointToPointEpcHelper::AddUe ( Ptr< NetDevice ueLteDevice,
uint64_t  imsi 
)
virtual

Notify the EPC of the existence of a new UE which might attach at a later time.

Parameters
ueLteDevicethe UE device to be attached
imsithe unique identifier of the UE

Implements ns3::EpcHelper.

Definition at line 362 of file point-to-point-epc-helper.cc.

References m_mme, m_sgwPgwApp, and NS_LOG_FUNCTION.

Referenced by EpcS1uDlTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

◆ AddX2Interface()

void ns3::PointToPointEpcHelper::AddX2Interface ( Ptr< Node enbNode1,
Ptr< Node enbNode2 
)
virtual

◆ AssignUeIpv4Address()

Ipv4InterfaceContainer ns3::PointToPointEpcHelper::AssignUeIpv4Address ( NetDeviceContainer  ueDevices)
virtual

Assign IPv4 addresses to UE devices.

Parameters
ueDevicesthe set of UE devices
Returns
the interface container,
See also
Ipv4AddressHelper::Assign() which has similar semantics

Implements ns3::EpcHelper.

Definition at line 421 of file point-to-point-epc-helper.cc.

References ns3::Ipv4AddressHelper::Assign(), and m_uePgwAddressHelper.

Referenced by LteX2HandoverTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), LteCellSelectionTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), and PointToPointEpcHelper().

◆ AssignUeIpv6Address()

Ipv6InterfaceContainer ns3::PointToPointEpcHelper::AssignUeIpv6Address ( NetDeviceContainer  ueDevices)
virtual

Assign IPv6 addresses to UE devices.

Parameters
ueDevicesthe set of UE devices
Returns
the interface container,
See also
Ipv6AddressHelper::Assign() which has similar semantics

Implements ns3::EpcHelper.

Definition at line 427 of file point-to-point-epc-helper.cc.

References ns3::Ipv6AddressHelper::Assign(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and m_uePgwAddressHelper6.

Referenced by PointToPointEpcHelper().

◆ DoDispose()

void ns3::PointToPointEpcHelper::DoDispose ( void  )
virtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::EpcHelper.

Definition at line 209 of file point-to-point-epc-helper.cc.

References ns3::Object::Dispose(), m_sgwPgw, m_sgwPgwApp, m_tunDevice, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::VirtualNetDevice::SetSendCallback().

◆ GetInstanceTypeId()

TypeId ns3::PointToPointEpcHelper::GetInstanceTypeId ( ) const
virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns
The TypeId associated to the most-derived type of this instance.

Reimplemented from ns3::Object.

Definition at line 203 of file point-to-point-epc-helper.cc.

References GetTypeId().

◆ GetPgwNode()

Ptr< Node > ns3::PointToPointEpcHelper::GetPgwNode ( )
virtual
Returns
a pointer to the node implementing PGW functionality. Note that in this particular implementation this node will also hold the SGW functionality. The primary use intended for this method is to allow the user to configure the Gi interface of the PGW, i.e., to connect the PGW to the internet.

Implements ns3::EpcHelper.

Definition at line 415 of file point-to-point-epc-helper.cc.

References m_sgwPgw.

Referenced by LteX2HandoverTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), LteCellSelectionTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

◆ GetTypeId()

TypeId ns3::PointToPointEpcHelper::GetTypeId ( void  )
static

◆ GetUeDefaultGatewayAddress()

Ipv4Address ns3::PointToPointEpcHelper::GetUeDefaultGatewayAddress ( )
virtual
Returns
the IPv4 address of the Default Gateway to be used by UEs to reach the internet

Implements ns3::EpcHelper.

Definition at line 440 of file point-to-point-epc-helper.cc.

References ns3::Object::GetObject(), and m_sgwPgw.

Referenced by LteX2HandoverTestCase::DoRun(), LteCellSelectionTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

◆ GetUeDefaultGatewayAddress6()

Ipv6Address ns3::PointToPointEpcHelper::GetUeDefaultGatewayAddress6 ( )
virtual
Returns
the IPv6 address of the Default Gateway to be used by UEs to reach the internet

Implements ns3::EpcHelper.

Definition at line 447 of file point-to-point-epc-helper.cc.

References ns3::Ipv6::GetAddress(), ns3::Object::GetObject(), and m_sgwPgw.

Member Data Documentation

◆ m_enablePcapOverS1U

bool ns3::PointToPointEpcHelper::m_enablePcapOverS1U
private

Enable PCAP generation for S1U link.

Definition at line 188 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_enablePcapOverX2

bool ns3::PointToPointEpcHelper::m_enablePcapOverX2
private

Enable PCAP generation for X2 link.

Definition at line 179 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and GetTypeId().

◆ m_gtpuUdpPort

uint16_t ns3::PointToPointEpcHelper::m_gtpuUdpPort
private

UDP port where the GTP-U Socket is bound, fixed by the standard as 2152.

Definition at line 148 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and PointToPointEpcHelper().

◆ m_imsiEnbDeviceMap

std::map<uint64_t, Ptr<NetDevice> > ns3::PointToPointEpcHelper::m_imsiEnbDeviceMap
private

Map storing for each IMSI the corresponding eNB NetDevice.

Definition at line 153 of file point-to-point-epc-helper.h.

◆ m_mme

Ptr<EpcMme> ns3::PointToPointEpcHelper::m_mme
private

MME network element.

Definition at line 116 of file point-to-point-epc-helper.h.

Referenced by ActivateEpsBearer(), AddEnb(), AddUe(), and PointToPointEpcHelper().

◆ m_s1uIpv4AddressHelper

Ipv4AddressHelper ns3::PointToPointEpcHelper::m_s1uIpv4AddressHelper
private

S1-U interfaces.

helper to assign addresses to S1-U NetDevices

Definition at line 125 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and PointToPointEpcHelper().

◆ m_s1uLinkDataRate

DataRate ns3::PointToPointEpcHelper::m_s1uLinkDataRate
private

The data rate to be used for the next S1-U link to be created.

Definition at line 130 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_s1uLinkDelay

Time ns3::PointToPointEpcHelper::m_s1uLinkDelay
private

The delay to be used for the next S1-U link to be created.

Definition at line 135 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_s1uLinkMtu

uint16_t ns3::PointToPointEpcHelper::m_s1uLinkMtu
private

The MTU of the next S1-U link to be created.

Note that, because of the additional GTP/UDP/IP tunneling overhead, you need a MTU larger than the end-to-end MTU that you want to support.

Definition at line 143 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_s1uLinkPcapPrefix

std::string ns3::PointToPointEpcHelper::m_s1uLinkPcapPrefix
private

Prefix for the PCAP file for the S1 link.

Definition at line 193 of file point-to-point-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_sgwPgw

Ptr<Node> ns3::PointToPointEpcHelper::m_sgwPgw
private

◆ m_sgwPgwApp

Ptr<EpcSgwPgwApplication> ns3::PointToPointEpcHelper::m_sgwPgwApp
private

SGW-PGW application.

Definition at line 106 of file point-to-point-epc-helper.h.

Referenced by ActivateEpsBearer(), AddEnb(), AddUe(), DoDispose(), and PointToPointEpcHelper().

◆ m_tunDevice

Ptr<VirtualNetDevice> ns3::PointToPointEpcHelper::m_tunDevice
private

TUN device implementing tunneling of user data over GTP-U/UDP/IP.

Definition at line 111 of file point-to-point-epc-helper.h.

Referenced by DoDispose(), and PointToPointEpcHelper().

◆ m_uePgwAddressHelper

Ipv4AddressHelper ns3::PointToPointEpcHelper::m_uePgwAddressHelper
private

helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW

Definition at line 92 of file point-to-point-epc-helper.h.

Referenced by AssignUeIpv4Address(), and PointToPointEpcHelper().

◆ m_uePgwAddressHelper6

Ipv6AddressHelper ns3::PointToPointEpcHelper::m_uePgwAddressHelper6
private

helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW

Definition at line 96 of file point-to-point-epc-helper.h.

Referenced by AssignUeIpv6Address(), and PointToPointEpcHelper().

◆ m_x2Ipv4AddressHelper

Ipv4AddressHelper ns3::PointToPointEpcHelper::m_x2Ipv4AddressHelper
private

helper to assign addresses to X2 NetDevices

Definition at line 158 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and PointToPointEpcHelper().

◆ m_x2LinkDataRate

DataRate ns3::PointToPointEpcHelper::m_x2LinkDataRate
private

The data rate to be used for the next X2 link to be created.

Definition at line 163 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and GetTypeId().

◆ m_x2LinkDelay

Time ns3::PointToPointEpcHelper::m_x2LinkDelay
private

The delay to be used for the next X2 link to be created.

Definition at line 168 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and GetTypeId().

◆ m_x2LinkMtu

uint16_t ns3::PointToPointEpcHelper::m_x2LinkMtu
private

The MTU of the next X2 link to be created.

Note that, because of some big X2 messages, you need a big MTU.

Definition at line 174 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and GetTypeId().

◆ m_x2LinkPcapPrefix

std::string ns3::PointToPointEpcHelper::m_x2LinkPcapPrefix
private

Prefix for the PCAP file for the X2 link.

Definition at line 183 of file point-to-point-epc-helper.h.

Referenced by AddX2Interface(), and GetTypeId().


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