A Discrete-Event Network Simulator
API
emu-epc-helper.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011-2013 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Jaume Nin <jnin@cttc.es>
19  * Nicola Baldo <nbaldo@cttc.es>
20  * Manuel Requena <manuel.requena@cttc.es>
21  */
22 
23 #ifndef EMU_EPC_HELPER_H
24 #define EMU_EPC_HELPER_H
25 
26 #include <ns3/object.h>
27 #include <ns3/ipv4-address-helper.h>
28 #include <ns3/data-rate.h>
29 #include <ns3/epc-tft.h>
30 #include <ns3/eps-bearer.h>
31 #include <ns3/epc-helper.h>
32 
33 namespace ns3 {
34 
35 class Node;
36 class NetDevice;
37 class VirtualNetDevice;
38 class EpcSgwPgwApplication;
39 class EpcX2;
40 class EpcMme;
41 
53 class EmuEpcHelper : public EpcHelper
54 {
55 public:
56 
60  EmuEpcHelper ();
61 
65  virtual ~EmuEpcHelper ();
66 
67  // inherited from Object
72  static TypeId GetTypeId (void);
73  virtual void DoInitialize ();
74  virtual void DoDispose ();
75 
76  // inherited from EpcHelper
77  virtual void AddEnb (Ptr<Node> enbNode, Ptr<NetDevice> lteEnbNetDevice, uint16_t cellId);
78  virtual void AddUe (Ptr<NetDevice> ueLteDevice, uint64_t imsi);
79  virtual void AddX2Interface (Ptr<Node> enbNode1, Ptr<Node> enbNode2);
80  virtual uint8_t ActivateEpsBearer (Ptr<NetDevice> ueLteDevice, uint64_t imsi, Ptr<EpcTft> tft, EpsBearer bearer);
81  virtual Ptr<Node> GetPgwNode ();
84 
85 
86 
87 private:
88 
93 
98 
103 
108 
113 
118 
122  uint16_t m_gtpuUdpPort;
123 
128  std::map<uint64_t, Ptr<NetDevice> > m_imsiEnbDeviceMap;
129 
134 
138  std::string m_sgwDeviceName;
139 
143  std::string m_enbDeviceName;
144 
148  std::string m_sgwMacAddress;
149 
153  std::string m_enbMacAddressBase;
154 };
155 
156 
157 
158 
159 } // namespace ns3
160 
161 #endif // EMU_EPC_HELPER_H
static TypeId GetTypeId(void)
Register this type.
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.
holds a vector of std::pair of Ptr and interface index.
uint16_t m_gtpuUdpPort
UDP port where the GTP-U Socket is bound, fixed by the standard as 2152.
std::string m_sgwDeviceName
The name of the device used for the S1-U interface of the SGW.
Ipv4InterfaceContainer m_sgwIpIfaces
Container for Ipv4Interfaces of the SGW/PGW.
EmuEpcHelper()
Constructor.
std::map< uint64_t, Ptr< NetDevice > > m_imsiEnbDeviceMap
Map storing for each IMSI the corresponding eNB NetDevice.
virtual void AddUe(Ptr< NetDevice > ueLteDevice, uint64_t imsi)
Notify the EPC of the existance of a new UE which might attach at a later time.
virtual void DoInitialize()
Initialize() implementation.
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:71
holds a vector of ns3::NetDevice pointers
virtual void AddX2Interface(Ptr< Node > enbNode1, Ptr< Node > enbNode2)
Add an X2 interface between two eNB.
virtual void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)
Add an eNB to the EPC.
Create an EPC network using EmuFdNetDevice.
std::string m_enbMacAddressBase
First 5 bytes of the Enb MAC address base.
std::string m_sgwMacAddress
MAC address used for the SGW.
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:50
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual Ipv4Address GetUeDefaultGatewayAddress()
virtual Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices)
Assign IPv4 addresses to UE devices.
virtual ~EmuEpcHelper()
Destructor.
Ptr< EpcSgwPgwApplication > m_sgwPgwApp
SGW-PGW application.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
virtual Ptr< Node > GetPgwNode()
std::string m_enbDeviceName
The name of the device used for the S1-U interface of the eNB.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Ipv4AddressHelper m_ueAddressHelper
helper to assign addresses to UE devices as well as to the TUN device of the SGW/PGW ...
Ipv4AddressHelper m_epcIpv4AddressHelper
helper to assign addresses to S1-U NetDevices
virtual void DoDispose()
Destructor implementation.
Ptr< VirtualNetDevice > m_tunDevice
TUN device implementing tunneling of user data over GTP-U/UDP/IP.
a unique identifier for an interface.
Definition: type-id.h:58
Ptr< Node > m_sgwPgw
SGW-PGW network element.
Ptr< EpcMme > m_mme
MME network element.