A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::EpcSgwPgwApplication Class Reference

#include <epc-sgw-pgw-application.h>

+ Inheritance diagram for ns3::EpcSgwPgwApplication:

Classes

struct  EnbInfo
 
class  UeInfo
 

Public Member Functions

 EpcSgwPgwApplication (const Ptr< VirtualNetDevice > tunDevice, const Ptr< Socket > s1uSocket)
 
virtual ~EpcSgwPgwApplication (void)
 
void AddEnb (uint16_t cellId, Ipv4Address enbAddr, Ipv4Address sgwAddr)
 
void AddUe (uint64_t imsi)
 
virtual void DoDispose ()
 
EpcS11SapSgwGetS11SapSgw ()
 
void RecvFromS1uSocket (Ptr< Socket > socket)
 
bool RecvFromTunDevice (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
 
void SendToS1uSocket (Ptr< Packet > packet, Ipv4Address enbS1uAddress, uint32_t teid)
 
void SendToTunDevice (Ptr< Packet > packet, uint32_t teid)
 
void SetS11SapMme (EpcS11SapMme *s)
 
void SetUeAddress (uint64_t imsi, Ipv4Address ueAddr)
 
- Public Member Functions inherited from ns3::Application
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

void DoCreateSessionRequest (EpcS11SapSgw::CreateSessionRequestMessage msg)
 
void DoModifyBearerRequest (EpcS11SapSgw::ModifyBearerRequestMessage msg)
 

Private Attributes

std::map< uint16_t, EnbInfom_enbInfoByCellId
 
uint16_t m_gtpuUdpPort
 
EpcS11SapMmem_s11SapMme
 
EpcS11SapSgwm_s11SapSgw
 
Ptr< Socketm_s1uSocket
 
uint32_t m_teidCount
 
Ptr< VirtualNetDevicem_tunDevice
 
std::map< Ipv4Address, Ptr
< UeInfo > > 
m_ueInfoByAddrMap
 
std::map< uint64_t, Ptr< UeInfo > > m_ueInfoByImsiMap
 

Friends

class MemberEpcS11SapSgw< EpcSgwPgwApplication >
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 
EventId m_startEvent
 
Time m_startTime
 
EventId m_stopEvent
 
Time m_stopTime
 

Detailed Description

This application implements the SGW/PGW functionality.

Definition at line 48 of file epc-sgw-pgw-application.h.

Constructor & Destructor Documentation

ns3::EpcSgwPgwApplication::EpcSgwPgwApplication ( const Ptr< VirtualNetDevice tunDevice,
const Ptr< Socket s1uSocket 
)

Constructor that binds the tap device to the callback methods.

Parameters
tunDeviceTUN VirtualNetDevice used to tunnel IP packets from the Gi interface of the PGW/SGW over the internet over GTP-U/UDP/IP on the S1-U interface
s1uSocketsocket used to send GTP-U packets to the eNBs

Definition at line 112 of file epc-sgw-pgw-application.cc.

References m_s11SapSgw, m_s1uSocket, ns3::MakeCallback(), NS_LOG_FUNCTION, RecvFromS1uSocket(), and ns3::Socket::SetRecvCallback().

ns3::EpcSgwPgwApplication::~EpcSgwPgwApplication ( void  )
virtual

Destructor

Definition at line 125 of file epc-sgw-pgw-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::EpcSgwPgwApplication::AddEnb ( uint16_t  cellId,
Ipv4Address  enbAddr,
Ipv4Address  sgwAddr 
)

Let the SGW be aware of a new eNB

Parameters
cellIdthe cell identifier
enbAddthe address of the eNB

Definition at line 223 of file epc-sgw-pgw-application.cc.

References NS_LOG_FUNCTION.

void ns3::EpcSgwPgwApplication::AddUe ( uint64_t  imsi)

Let the SGW be aware of a new UE

Parameters
imsithe unique identifier of the UE

Definition at line 233 of file epc-sgw-pgw-application.cc.

References m_ueInfoByImsiMap, and NS_LOG_FUNCTION.

void ns3::EpcSgwPgwApplication::DoDispose ( void  )
virtual

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

Subclasses are expected to implement their real destruction code in an overriden 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::Application.

Definition at line 102 of file epc-sgw-pgw-application.cc.

References m_s11SapSgw, m_s1uSocket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

EpcS11SapSgw * ns3::EpcSgwPgwApplication::GetS11SapSgw ( )
Returns
the SGW side of the S11 SAP

Definition at line 217 of file epc-sgw-pgw-application.cc.

References m_s11SapSgw.

void ns3::EpcSgwPgwApplication::RecvFromS1uSocket ( Ptr< Socket socket)

Method to be assigned to the recv callback of the S1-U socket. It is called when the SGW/PGW receives a data packet from the eNB that is to be forwarded to the internet.

Parameters
socketpointer to the S1-U socket

Definition at line 170 of file epc-sgw-pgw-application.cc.

References m_s1uSocket, NS_ASSERT, NS_LOG_FUNCTION, ns3::Socket::Recv(), ns3::Packet::RemoveHeader(), ns3::Packet::RemovePacketTag(), and SendToTunDevice().

Referenced by EpcSgwPgwApplication().

bool ns3::EpcSgwPgwApplication::RecvFromTunDevice ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
)

Method to be assigned to the callback of the Gi TUN VirtualNetDevice. It is called when the SGW/PGW receives a data packet from the internet (including IP headers) that is to be sent to the UE via its associated eNB, tunneling IP over GTP-U/UDP/IP.

Parameters
packet
source
dest
protocolNumber
Returns
true always

Definition at line 132 of file epc-sgw-pgw-application.cc.

References ns3::Packet::Copy(), ns3::Ipv4Header::GetDestination(), ns3::Packet::GetSize(), m_ueInfoByAddrMap, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, and SendToS1uSocket().

Referenced by ns3::EpcHelper::EpcHelper().

void ns3::EpcSgwPgwApplication::SendToS1uSocket ( Ptr< Packet packet,
Ipv4Address  enbS1uAddress,
uint32_t  teid 
)

Send a packet to the SGW via the S1-U interface

Parameters
packetpacket to be sent
enbS1uAddressthe address of the eNB
teidthe Tunnel Enpoint IDentifier

Definition at line 195 of file epc-sgw-pgw-application.cc.

References ns3::Packet::AddHeader(), ns3::GtpuHeader::GetSerializedSize(), ns3::Packet::GetSize(), m_gtpuUdpPort, m_s1uSocket, NS_LOG_FUNCTION, and ns3::Socket::SendTo().

Referenced by RecvFromTunDevice().

void ns3::EpcSgwPgwApplication::SendToTunDevice ( Ptr< Packet packet,
uint32_t  teid 
)

Send a packet to the internet via the Gi interface of the SGW/PGW

Parameters
packet

Definition at line 187 of file epc-sgw-pgw-application.cc.

References ns3::VirtualNetDevice::GetAddress(), ns3::Packet::GetSize(), m_tunDevice, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::NetDevice::PACKET_HOST, and ns3::VirtualNetDevice::Receive().

Referenced by RecvFromS1uSocket().

void ns3::EpcSgwPgwApplication::SetS11SapMme ( EpcS11SapMme s)

Set the MME side of the S11 SAP

Parameters
sthe MME side of the S11 SAP

Definition at line 211 of file epc-sgw-pgw-application.cc.

References m_s11SapMme.

void ns3::EpcSgwPgwApplication::SetUeAddress ( uint64_t  imsi,
Ipv4Address  ueAddr 
)

set the address of a previously added UE

Parameters
imsithe unique identifier of the UE
ueAddrthe IPv4 address of the UE

Definition at line 241 of file epc-sgw-pgw-application.cc.

References m_ueInfoByAddrMap, m_ueInfoByImsiMap, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Member Data Documentation

uint16_t ns3::EpcSgwPgwApplication::m_gtpuUdpPort
private

UDP port to be used for GTP

Definition at line 242 of file epc-sgw-pgw-application.h.

Referenced by SendToS1uSocket().

EpcS11SapMme* ns3::EpcSgwPgwApplication::m_s11SapMme
private

MME side of the S11 SAP

Definition at line 250 of file epc-sgw-pgw-application.h.

Referenced by SetS11SapMme().

EpcS11SapSgw* ns3::EpcSgwPgwApplication::m_s11SapSgw
private

SGW side of the S11 SAP

Definition at line 256 of file epc-sgw-pgw-application.h.

Referenced by DoDispose(), EpcSgwPgwApplication(), and GetS11SapSgw().

Ptr<Socket> ns3::EpcSgwPgwApplication::m_s1uSocket
private

UDP socket to send and receive GTP-U packets to and from the S1-U interface

Definition at line 221 of file epc-sgw-pgw-application.h.

Referenced by DoDispose(), EpcSgwPgwApplication(), RecvFromS1uSocket(), and SendToS1uSocket().

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

TUN VirtualNetDevice used for tunneling/detunneling IP packets from/to the internet over GTP-U/UDP/IP on the S1 interface

Definition at line 227 of file epc-sgw-pgw-application.h.

Referenced by SendToTunDevice().

std::map<Ipv4Address, Ptr<UeInfo> > ns3::EpcSgwPgwApplication::m_ueInfoByAddrMap
private

Map telling for each UE address the corresponding UE info

Definition at line 232 of file epc-sgw-pgw-application.h.

Referenced by RecvFromTunDevice(), and SetUeAddress().

std::map<uint64_t, Ptr<UeInfo> > ns3::EpcSgwPgwApplication::m_ueInfoByImsiMap
private

Map telling for each IMSI the corresponding UE info

Definition at line 237 of file epc-sgw-pgw-application.h.

Referenced by AddUe(), and SetUeAddress().


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