A Discrete-Event Network Simulator
API
udp-echo.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
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 
17 // Network topology
18 //
19 // n0 n1 n2 n3
20 // | | | |
21 // =================
22 // LAN
23 //
24 // - UDP flows from n0 to n1 and back
25 // - DropTail queues
26 // - Tracing of queues and packet receptions to file "udp-echo.tr"
27 
28 #include <fstream>
29 #include "ns3/core-module.h"
30 #include "ns3/csma-module.h"
31 #include "ns3/applications-module.h"
32 #include "ns3/internet-module.h"
33 
34 using namespace ns3;
35 
36 NS_LOG_COMPONENT_DEFINE ("UdpEchoExample");
37 
38 int
39 main (int argc, char *argv[])
40 {
41 //
42 // Users may find it convenient to turn on explicit debugging
43 // for selected modules; the below lines suggest how to do this
44 //
45 #if 0
46  LogComponentEnable ("UdpEchoExample", LOG_LEVEL_INFO);
47  LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_ALL);
48  LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_ALL);
49 #endif
50 //
51 // Allow the user to override any of the defaults and the above Bind() at
52 // run-time, via command-line arguments
53 //
54  bool useV6 = false;
55  Address serverAddress;
56 
57  CommandLine cmd (__FILE__);
58  cmd.AddValue ("useIpv6", "Use Ipv6", useV6);
59  cmd.Parse (argc, argv);
60 //
61 // Explicitly create the nodes required by the topology (shown above).
62 //
63  NS_LOG_INFO ("Create nodes.");
65  n.Create (4);
66 
67  InternetStackHelper internet;
68  internet.Install (n);
69 
70  NS_LOG_INFO ("Create channels.");
71 //
72 // Explicitly create the channels required by the topology (shown above).
73 //
75  csma.SetChannelAttribute ("DataRate", DataRateValue (DataRate (5000000)));
76  csma.SetChannelAttribute ("Delay", TimeValue (MilliSeconds (2)));
77  csma.SetDeviceAttribute ("Mtu", UintegerValue (1400));
78  NetDeviceContainer d = csma.Install (n);
79 
80 //
81 // We've got the "hardware" in place. Now we need to add IP addresses.
82 //
83  NS_LOG_INFO ("Assign IP Addresses.");
84  if (useV6 == false)
85  {
86  Ipv4AddressHelper ipv4;
87  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
88  Ipv4InterfaceContainer i = ipv4.Assign (d);
89  serverAddress = Address(i.GetAddress (1));
90  }
91  else
92  {
93  Ipv6AddressHelper ipv6;
94  ipv6.SetBase ("2001:0000:f00d:cafe::", Ipv6Prefix (64));
95  Ipv6InterfaceContainer i6 = ipv6.Assign (d);
96  serverAddress = Address(i6.GetAddress (1,1));
97  }
98 
99  NS_LOG_INFO ("Create Applications.");
100 //
101 // Create a UdpEchoServer application on node one.
102 //
103  uint16_t port = 9; // well-known echo port number
104  UdpEchoServerHelper server (port);
105  ApplicationContainer apps = server.Install (n.Get (1));
106  apps.Start (Seconds (1.0));
107  apps.Stop (Seconds (10.0));
108 
109 //
110 // Create a UdpEchoClient application to send UDP datagrams from node zero to
111 // node one.
112 //
113  uint32_t packetSize = 1024;
114  uint32_t maxPacketCount = 1;
115  Time interPacketInterval = Seconds (1.);
116  UdpEchoClientHelper client (serverAddress, port);
117  client.SetAttribute ("MaxPackets", UintegerValue (maxPacketCount));
118  client.SetAttribute ("Interval", TimeValue (interPacketInterval));
119  client.SetAttribute ("PacketSize", UintegerValue (packetSize));
120  apps = client.Install (n.Get (0));
121  apps.Start (Seconds (2.0));
122  apps.Stop (Seconds (10.0));
123 
124 #if 0
125 //
126 // Users may find it convenient to initialize echo packets with actual data;
127 // the below lines suggest how to do this
128 //
129  client.SetFill (apps.Get (0), "Hello World");
130 
131  client.SetFill (apps.Get (0), 0xa5, 1024);
132 
133  uint8_t fill[] = { 0, 1, 2, 3, 4, 5, 6};
134  client.SetFill (apps.Get (0), fill, sizeof(fill), 1024);
135 #endif
136 
137  AsciiTraceHelper ascii;
138  csma.EnableAsciiAll (ascii.CreateFileStream ("udp-echo.tr"));
139  csma.EnablePcapAll ("udp-echo", false);
140 
141 //
142 // Now, do the actual simulation.
143 //
144  NS_LOG_INFO ("Run Simulation.");
145  Simulator::Run ();
147  NS_LOG_INFO ("Done.");
148 }
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:42
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
ns3::DataRateValue
AttributeValue implementation for DataRate.
Definition: data-rate.h:298
ns3::ApplicationContainer::Get
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
Definition: application-container.cc:62
ns3::CommandLine
Parse command-line arguments.
Definition: command-line.h:228
ns3::LOG_LEVEL_INFO
@ LOG_LEVEL_INFO
LOG_INFO and above.
Definition: log.h:107
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::ApplicationContainer::Stop
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
Definition: application-container.cc:107
ns3::Ipv4AddressHelper
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Definition: ipv4-address-helper.h:48
ns3::UdpEchoClientHelper
Create an application which sends a UDP packet and waits for an echo of this packet.
Definition: udp-echo-helper.h:107
ns3::LOG_LEVEL_ALL
@ LOG_LEVEL_ALL
Print everything.
Definition: log.h:116
ns3::LogComponentEnable
void LogComponentEnable(char const *name, enum LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:361
ns3::Ipv6AddressHelper::SetBase
void SetBase(Ipv6Address network, Ipv6Prefix prefix, Ipv6Address base=Ipv6Address("::1"))
Set the base network number, network prefix, and base interface ID.
Definition: ipv6-address-helper.cc:69
ns3::Ipv6AddressHelper
Helper class to auto-assign global IPv6 unicast addresses.
Definition: ipv6-address-helper.h:83
ns3::CsmaHelper
build a set of CsmaNetDevice objects
Definition: csma-helper.h:47
ns3::Ipv4AddressHelper::SetBase
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Definition: ipv4-address-helper.cc:64
ns3::Ipv6AddressHelper::Assign
Ipv6InterfaceContainer Assign(const NetDeviceContainer &c)
Allocate an Ipv6InterfaceContainer with auto-assigned addresses.
Definition: ipv6-address-helper.cc:210
ns3::DataRate
Class for representing data rates.
Definition: data-rate.h:89
ns3::Address
a polymophic address class
Definition: address.h:91
ns3::InternetStackHelper::Install
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
Definition: internet-stack-helper.cc:366
NS_LOG_INFO
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
ns3::AsciiTraceHelper::CreateFileStream
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Definition: trace-helper.cc:191
ns3::MilliSeconds
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1297
ns3::Ipv6InterfaceContainer::GetAddress
Ipv6Address GetAddress(uint32_t i, uint32_t j) const
Get the address for the specified index.
Definition: ipv6-interface-container.cc:57
ns3::Ipv4InterfaceContainer
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Definition: ipv4-interface-container.h:55
ns3::Ipv6InterfaceContainer
Keep track of a set of IPv6 interfaces.
Definition: ipv6-interface-container.h:42
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
second.cmd
cmd
Definition: second.py:35
ns3::Simulator::Run
static void Run(void)
Run the simulation.
Definition: simulator.cc:172
ns3::AsciiTraceHelper
Manage ASCII trace files for device models.
Definition: trace-helper.h:163
packetSize
static const uint32_t packetSize
Definition: wifi-power-adaptation-distance.cc:113
ns3::ApplicationContainer::Start
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter.
Definition: application-container.cc:87
ns3::Seconds
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1289
ns3::Ipv4AddressHelper::Assign
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
Definition: ipv4-address-helper.cc:135
ns3::Simulator::Destroy
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:136
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition: application-container.h:43
ns3::TimeValue
AttributeValue implementation for Time.
Definition: nstime.h:1353
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::Ipv4InterfaceContainer::GetAddress
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Definition: ipv4-interface-container.cc:59
ns3::UintegerValue
Hold an unsigned integer type.
Definition: uinteger.h:44
ns3::UdpEchoServerHelper
Create a server application which waits for input UDP packets and sends them back to the original sen...
Definition: udp-echo-helper.h:38
ns3::Ipv6Prefix
Describes an IPv6 prefix.
Definition: ipv6-address.h:456
ns3::InternetStackHelper
aggregate IP/TCP/UDP functionality to existing Nodes.
Definition: internet-stack-helper.h:88
second.csma
csma
Definition: second.py:63
sample-rng-plot.n
n
Definition: sample-rng-plot.py:37
port
uint16_t port
Definition: dsdv-manet.cc:45