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< Node >	GetPgwNode ()

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...

SimpleRefCount &	operator= (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< EpcMme >	m_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< Node >	m_sgwPgw
	SGW-PGW network element. More...

Ptr< EpcSgwPgwApplication >	m_sgwPgwApp
	SGW-PGW application. More...

Ptr< VirtualNetDevice >	m_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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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

S1uLinkDataRate: The data rate to be used for the next S1-U link to be created
- Set with class: DataRateValue
- Underlying type: DataRate
- Initial value: 10000000000bps
- Flags: construct write read
S1uLinkDelay: The delay to be used for the next S1-U link to be created
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read
S1uLinkMtu: 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.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 2000
- Flags: construct write read
X2LinkDataRate: The data rate to be used for the next X2 link to be created
- Set with class: DataRateValue
- Underlying type: DataRate
- Initial value: 10000000000bps
- Flags: construct write read
X2LinkDelay: The delay to be used for the next X2 link to be created
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read
X2LinkMtu: The MTU of the next X2 link to be created. Note that, because of some big X2 messages, you need a big MTU.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 3000
- Flags: construct write read
S1uLinkPcapPrefix: Prefix for Pcap generated by S1-U link
- Set with class: StringValue
- Underlying type:
- Initial value: s1-u
- Flags: construct write read
X2LinkPcapPrefix: Prefix for Pcap generated by X2 link
- Set with class: StringValue
- Underlying type:
- Initial value: x2
- Flags: construct write read
X2LinkEnablePcap: Enable Pcap for X2 link
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
S1uLinkEnablePcap: Enable Pcap for X2 link
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

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 ( )

Constructor.

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

References ns3::NetDeviceContainer::Add(), ns3::Node::AddApplication(), ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), AssignUeIpv4Address(), AssignUeIpv6Address(), ns3::Socket::Bind(), ns3::ObjectBase::ConstructSelf(), ns3::Socket::CreateSocket(), ns3::Ipv4Address::GetAny(), ns3::Object::GetObject(), ns3::Ipv6StaticRoutingHelper::GetStaticRouting(), ns3::InternetStackHelper::Install(), ns3::TypeId::LookupByName(), m_gtpuUdpPort, m_mme, m_s1uIpv4AddressHelper, m_sgwPgw, m_sgwPgwApp, m_tunDevice, m_uePgwAddressHelper, m_uePgwAddressHelper6, m_x2Ipv4AddressHelper, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, ns3::EpcSgwPgwApplication::RecvFromTunDevice(), ns3::VirtualNetDevice::SetAddress(), ns3::ObjectBase::SetAttribute(), ns3::Ipv4AddressHelper::SetBase(), ns3::Ipv6AddressHelper::SetBase(), ns3::Ipv6InterfaceContainer::SetDefaultRouteInAllNodes(), ns3::Ipv6InterfaceContainer::SetForwarding(), and ns3::VirtualNetDevice::SetSendCallback().

◆ ~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

ueLteDevice	the Ipv4-enabled device of the UE, normally connected via the LTE radio interface
imsi	the unique identifier of the UE
tft	the Traffic Flow Template of the new bearer
bearer	struct 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

Add an eNB to the EPC.

Parameters

enbNode	the previously created eNB node which is to be added to the EPC
lteEnbNetDevice	the LteEnbNetDevice of the eNB node
cellId	ID of the eNB

Implements ns3::EpcHelper.

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

References ns3::NodeContainer::Add(), ns3::Node::AddApplication(), ns3::Object::AggregateObject(), ns3::Ipv4AddressHelper::Assign(), ns3::Socket::Bind(), ns3::Socket::Connect(), ns3::Socket::CreateSocket(), ns3::PcapHelperForDevice::EnablePcapAll(), ns3::NetDeviceContainer::Get(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::Node::GetApplication(), ns3::Mac48Address::GetBroadcast(), ns3::Node::GetNApplications(), ns3::Ipv4::GetNInterfaces(), ns3::Object::GetObject(), ns3::PointToPointHelper::Install(), ns3::InternetStackHelper::Install(), ns3::TypeId::LookupByName(), m_enablePcapOverS1U, m_gtpuUdpPort, m_mme, m_s1uIpv4AddressHelper, m_s1uLinkDataRate, m_s1uLinkDelay, m_s1uLinkMtu, m_s1uLinkPcapPrefix, m_sgwPgw, m_sgwPgwApp, ns3::Ipv4AddressHelper::NewNetwork(), NS_ASSERT, NS_ASSERT_MSG(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC(), ns3::Ipv6L3Protocol::PROT_NUMBER, ns3::Ipv4L3Protocol::PROT_NUMBER, ns3::PointToPointHelper::SetChannelAttribute(), ns3::PointToPointHelper::SetDeviceAttribute(), ns3::PacketSocketAddress::SetPhysicalAddress(), ns3::PacketSocketAddress::SetProtocol(), and ns3::PacketSocketAddress::SetSingleDevice().

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

◆ 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

ueLteDevice	the UE device to be attached
imsi	the 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

Add an X2 interface between two eNB.

Parameters

enbNode1	one eNB peer of the X2 interface
enbNode2	the other eNB peer of the X2 interface

Implements ns3::EpcHelper.

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

References ns3::NodeContainer::Add(), ns3::Ipv4AddressHelper::Assign(), ns3::PcapHelperForDevice::EnablePcapAll(), ns3::NetDeviceContainer::Get(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::LteEnbNetDevice::GetCellId(), ns3::Node::GetDevice(), ns3::Ipv4::GetNInterfaces(), ns3::Object::GetObject(), ns3::PointToPointHelper::Install(), m_enablePcapOverX2, m_x2Ipv4AddressHelper, m_x2LinkDataRate, m_x2LinkDelay, m_x2LinkMtu, m_x2LinkPcapPrefix, ns3::Ipv4AddressHelper::NewNetwork(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), ns3::PointToPointHelper::SetChannelAttribute(), and ns3::PointToPointHelper::SetDeviceAttribute().

◆ AssignUeIpv4Address()

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

virtual

Assign IPv4 addresses to UE devices.

Parameters

ueDevices the 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

ueDevices the 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().