A Discrete-Event Network Simulator
API
uan-ipv4-example.cc
Go to the documentation of this file.
1 /*
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * Author: Hossam Khader <hossamkhader@gmail.com>
17  */
18 
19 #include "ns3/acoustic-modem-energy-model-helper.h"
20 #include "ns3/basic-energy-source-helper.h"
21 #include "ns3/core-module.h"
22 #include "ns3/energy-source-container.h"
23 #include "ns3/internet-module.h"
24 #include "ns3/mobility-helper.h"
25 #include "ns3/mobility-model.h"
26 #include "ns3/node-container.h"
27 #include "ns3/uan-channel.h"
28 #include "ns3/uan-helper.h"
29 
30 using namespace ns3;
31 
41 NS_LOG_COMPONENT_DEFINE("UanIpv4Example");
42 
43 class UanExperiment
44 {
45  public:
47 
52 
56  void SetupEnergy();
57 
62 
67 
71  void SendPackets();
72 
79  void SendSinglePacket(Ptr<Node> node, Ptr<Packet> pkt, Ipv4Address dst);
80 
86 
90  void Prepare();
91 
95  void Teardown();
96 
97  private:
98  NodeContainer m_nodes;
99  std::map<Ptr<Node>, Ptr<Socket>> m_sockets;
100 };
101 
103 {
104 }
105 
106 void
108 {
109  MobilityHelper mobilityHelper;
110  mobilityHelper.SetMobilityModel("ns3::ConstantPositionMobilityModel");
111  mobilityHelper.Install(m_nodes);
112  m_nodes.Get(0)->GetObject<MobilityModel>()->SetPosition(Vector(0, 0, 0));
113  m_nodes.Get(1)->GetObject<MobilityModel>()->SetPosition(Vector(100, 0, 0));
114  m_nodes.Get(2)->GetObject<MobilityModel>()->SetPosition(Vector(-100, 0, 0));
115 }
116 
117 void
119 {
120  BasicEnergySourceHelper energySourceHelper;
121  energySourceHelper.Set("BasicEnergySourceInitialEnergyJ", DoubleValue(900000));
122  energySourceHelper.Install(m_nodes);
123 }
124 
125 void
127 {
128  Ptr<UanChannel> channel = CreateObject<UanChannel>();
129  UanHelper uanHelper;
130  NetDeviceContainer netDeviceContainer = uanHelper.Install(m_nodes, channel);
131  EnergySourceContainer energySourceContainer;
132  auto node = m_nodes.Begin();
133  while (node != m_nodes.End())
134  {
135  energySourceContainer.Add((*node)->GetObject<EnergySourceContainer>()->Get(0));
136  node++;
137  }
138  AcousticModemEnergyModelHelper acousticModemEnergyModelHelper;
139  acousticModemEnergyModelHelper.Install(netDeviceContainer, energySourceContainer);
140 
141  InternetStackHelper internetStackHelper;
142  internetStackHelper.Install(m_nodes);
143 
144  Ipv4AddressHelper ipv4AddressHelper;
145  ipv4AddressHelper.SetBase("10.0.0.0", "255.255.255.0");
146  ipv4AddressHelper.Assign(netDeviceContainer);
147  node = m_nodes.Begin();
148  while (node != m_nodes.End())
149  {
150  (*node)->GetObject<Ipv4L3Protocol>()->GetInterface(1)->GetArpCache()->SetWaitReplyTimeout(
151  Seconds(10));
152  node++;
153  }
154 }
155 
156 void
158 {
159  Address srcAddress;
160  while (socket->GetRxAvailable() > 0)
161  {
162  Ptr<Packet> packet = socket->RecvFrom(srcAddress);
163  uint8_t energyReading;
164  packet->CopyData(&energyReading, 1);
165 
166  if (InetSocketAddress::IsMatchingType(srcAddress))
167  {
168  NS_LOG_UNCOND("Time: " << Simulator::Now().GetHours() << "h"
169  << " | Node: "
170  << InetSocketAddress::ConvertFrom(srcAddress).GetIpv4()
171  << " | Energy: " << +energyReading << "%");
172  }
173  }
174 }
175 
176 void
178 {
179  auto node = m_nodes.Begin();
180  while (node != m_nodes.End())
181  {
182  m_sockets[*node] =
183  Socket::CreateSocket(*node, TypeId::LookupByName("ns3::UdpSocketFactory"));
184  if ((*node)->GetObject<Ipv4>())
185  {
187  m_sockets[*node]->Bind(ipv4_local);
188  }
189 
190  m_sockets[*node]->SetRecvCallback(MakeCallback(&UanExperiment::PrintReceivedPacket, this));
191  node++;
192  }
193 }
194 
195 void
197 {
198  Ptr<UniformRandomVariable> uniformRandomVariable = CreateObject<UniformRandomVariable>();
199 
200  auto node = m_nodes.Begin();
201  Ipv4Address dst =
202  (*node)->GetObject<Ipv4L3Protocol>()->GetInterface(1)->GetAddress(0).GetLocal();
203  node++;
204  while (node != m_nodes.End())
205  {
206  uint8_t energy =
207  ((*node)->GetObject<EnergySourceContainer>()->Get(0)->GetEnergyFraction()) * 100;
208 
209  Ptr<Packet> pkt = Create<Packet>(&energy, 1);
210 
211  double time = uniformRandomVariable->GetValue(0, 60);
212  Simulator::Schedule(Seconds(time), &UanExperiment::SendSinglePacket, this, *node, pkt, dst);
213  node++;
214  }
216 }
217 
218 void
220 {
221  NS_LOG_UNCOND(Simulator::Now().GetHours() << "h"
222  << " packet sent to " << dst);
223  InetSocketAddress ipv4_destination = InetSocketAddress(dst, 9);
224  m_sockets[node]->SendTo(pkt, 0, ipv4_destination);
225 }
226 
227 void
229 {
230  m_nodes.Create(3);
231  SetupPositions();
232  SetupEnergy();
233  SetupCommunications();
234  SetupApplications();
235  SendPackets();
236 }
237 
238 void
240 {
241  for (auto socket = m_sockets.begin(); socket != m_sockets.end(); socket++)
242  {
243  socket->second->Close();
244  }
245 }
246 
247 int
248 main(int argc, char* argv[])
249 {
250  CommandLine cmd(__FILE__);
251  cmd.Parse(argc, argv);
252 
254  experiment.Prepare();
255 
256  Simulator::Stop(Days(50));
257  Simulator::Run();
259 
260  experiment.Teardown();
261 
262  return 0;
263 }
This example shows the usage of UDP over 6LoWPAN to transfer data.
void Teardown()
Teardown the experiment.
void PrintReceivedPacket(Ptr< Socket > socket)
Print the received packet.
void Prepare()
Prepare the experiment.
void SendSinglePacket(Ptr< Node > node, Ptr< Packet > pkt, Ipv6Address dst)
Send a packet from one of the nodes.
void SendPackets()
Send a packet from all the nodes.
void SetupCommunications()
Set the UAN nodes communication channels.
void SetupPositions()
Set the UAN nodes position.
void SetupApplications()
Set the UAN nodes communication channels.
void SetupEnergy()
Set the UAN nodes energy.
Assign AcousticModemEnergyModel to uan devices.
a polymophic address class
Definition: address.h:101
Creates a BasicEnergySource object.
void Set(std::string name, const AttributeValue &v) override
Parse command-line arguments.
Definition: command-line.h:232
DeviceEnergyModelContainer Install(Ptr< NetDevice > device, Ptr< EnergySource > source) const
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
Holds a vector of ns3::EnergySource pointers.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
Iterator Begin() const
Get an iterator which refers to the first EnergySource pointer in the container.
void Add(EnergySourceContainer container)
EnergySourceContainer Install(Ptr< Node > node) const
an Inet address class
static bool IsMatchingType(const Address &address)
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
aggregate IP/TCP/UDP functionality to existing Nodes.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
static Ipv4Address GetAny()
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:80
Ipv4Address GetLocal() const
Get the local address.
Iterator Begin() const
Get an iterator which refers to the first pair in the container.
Implement the IPv4 layer.
Ipv4InterfaceAddress GetAddress(uint32_t interfaceIndex, uint32_t addressIndex) const override
Because addresses can be removed, the addressIndex is not guaranteed to be static across calls to thi...
Helper class used to assign positions and mobility models to nodes.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetMobilityModel(std::string type, Ts &&... args)
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:400
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:571
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
virtual uint32_t GetRxAvailable() const =0
Return number of bytes which can be returned from one or multiple calls to Recv.
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:72
virtual int Close()=0
Close a socket.
virtual Ptr< Packet > RecvFrom(uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
Read a single packet from the socket and retrieve the sender address.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:835
UAN configuration helper.
Definition: uan-helper.h:42
NetDeviceContainer Install(NodeContainer c) const
This method creates a simple ns3::UanChannel (with a default ns3::UanNoiseModelDefault and ns3::UanPr...
Definition: uan-helper.cc:145
double GetValue(double min, double max)
Get the next random value drawn from the distribution.
void experiment(std::string queue_disc_type)
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
Time Days(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1290
Time Hours(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1302
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704
cmd
Definition: second.py:40
channel
Definition: third.py:88