A Discrete-Event Network Simulator
API
udp-echo-client.cc
Go to the documentation of this file.
1/*
2 * Copyright 2007 University of Washington
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 */
17#include "udp-echo-client.h"
18
19#include "ns3/inet-socket-address.h"
20#include "ns3/inet6-socket-address.h"
21#include "ns3/ipv4-address.h"
22#include "ns3/ipv6-address.h"
23#include "ns3/log.h"
24#include "ns3/nstime.h"
25#include "ns3/packet.h"
26#include "ns3/simulator.h"
27#include "ns3/socket-factory.h"
28#include "ns3/socket.h"
29#include "ns3/trace-source-accessor.h"
30#include "ns3/uinteger.h"
31
32namespace ns3
33{
34
35NS_LOG_COMPONENT_DEFINE("UdpEchoClientApplication");
36
37NS_OBJECT_ENSURE_REGISTERED(UdpEchoClient);
38
39TypeId
41{
42 static TypeId tid =
43 TypeId("ns3::UdpEchoClient")
45 .SetGroupName("Applications")
46 .AddConstructor<UdpEchoClient>()
47 .AddAttribute(
48 "MaxPackets",
49 "The maximum number of packets the application will send (zero means infinite)",
50 UintegerValue(100),
52 MakeUintegerChecker<uint32_t>())
53 .AddAttribute("Interval",
54 "The time to wait between packets",
55 TimeValue(Seconds(1.0)),
58 .AddAttribute("RemoteAddress",
59 "The destination Address of the outbound packets",
61 MakeAddressAccessor(&UdpEchoClient::m_peerAddress),
62 MakeAddressChecker())
63 .AddAttribute("RemotePort",
64 "The destination port of the outbound packets",
67 MakeUintegerChecker<uint16_t>())
68 .AddAttribute(
69 "PacketSize",
70 "Size of echo data in outbound packets",
71 UintegerValue(100),
73 MakeUintegerChecker<uint32_t>())
74 .AddTraceSource("Tx",
75 "A new packet is created and is sent",
77 "ns3::Packet::TracedCallback")
78 .AddTraceSource("Rx",
79 "A packet has been received",
81 "ns3::Packet::TracedCallback")
82 .AddTraceSource("TxWithAddresses",
83 "A new packet is created and is sent",
85 "ns3::Packet::TwoAddressTracedCallback")
86 .AddTraceSource("RxWithAddresses",
87 "A packet has been received",
89 "ns3::Packet::TwoAddressTracedCallback");
90 return tid;
91}
92
94{
95 NS_LOG_FUNCTION(this);
96 m_sent = 0;
97 m_socket = nullptr;
99 m_data = nullptr;
100 m_dataSize = 0;
101}
102
104{
105 NS_LOG_FUNCTION(this);
106 m_socket = nullptr;
107
108 delete[] m_data;
109 m_data = nullptr;
110 m_dataSize = 0;
111}
112
113void
115{
116 NS_LOG_FUNCTION(this << ip << port);
117 m_peerAddress = ip;
119}
120
121void
123{
124 NS_LOG_FUNCTION(this << addr);
125 m_peerAddress = addr;
126}
127
128void
130{
131 NS_LOG_FUNCTION(this);
133}
134
135void
137{
138 NS_LOG_FUNCTION(this);
139
140 if (!m_socket)
141 {
142 TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
145 {
146 if (m_socket->Bind() == -1)
147 {
148 NS_FATAL_ERROR("Failed to bind socket");
149 }
152 }
154 {
155 if (m_socket->Bind6() == -1)
156 {
157 NS_FATAL_ERROR("Failed to bind socket");
158 }
161 }
163 {
164 if (m_socket->Bind() == -1)
165 {
166 NS_FATAL_ERROR("Failed to bind socket");
167 }
169 }
171 {
172 if (m_socket->Bind6() == -1)
173 {
174 NS_FATAL_ERROR("Failed to bind socket");
175 }
177 }
178 else
179 {
180 NS_ASSERT_MSG(false, "Incompatible address type: " << m_peerAddress);
181 }
182 }
183
187}
188
189void
191{
192 NS_LOG_FUNCTION(this);
193
194 if (m_socket)
195 {
196 m_socket->Close();
198 m_socket = nullptr;
199 }
200
202}
203
204void
206{
207 NS_LOG_FUNCTION(this << dataSize);
208
209 //
210 // If the client is setting the echo packet data size this way, we infer
211 // that she doesn't care about the contents of the packet at all, so
212 // neither will we.
213 //
214 delete[] m_data;
215 m_data = nullptr;
216 m_dataSize = 0;
217 m_size = dataSize;
218}
219
222{
223 NS_LOG_FUNCTION(this);
224 return m_size;
225}
226
227void
228UdpEchoClient::SetFill(std::string fill)
229{
230 NS_LOG_FUNCTION(this << fill);
231
232 uint32_t dataSize = fill.size() + 1;
233
234 if (dataSize != m_dataSize)
235 {
236 delete[] m_data;
237 m_data = new uint8_t[dataSize];
238 m_dataSize = dataSize;
239 }
240
241 memcpy(m_data, fill.c_str(), dataSize);
242
243 //
244 // Overwrite packet size attribute.
245 //
246 m_size = dataSize;
247}
248
249void
250UdpEchoClient::SetFill(uint8_t fill, uint32_t dataSize)
251{
252 NS_LOG_FUNCTION(this << fill << dataSize);
253 if (dataSize != m_dataSize)
254 {
255 delete[] m_data;
256 m_data = new uint8_t[dataSize];
257 m_dataSize = dataSize;
258 }
259
260 memset(m_data, fill, dataSize);
261
262 //
263 // Overwrite packet size attribute.
264 //
265 m_size = dataSize;
266}
267
268void
269UdpEchoClient::SetFill(uint8_t* fill, uint32_t fillSize, uint32_t dataSize)
270{
271 NS_LOG_FUNCTION(this << fill << fillSize << dataSize);
272 if (dataSize != m_dataSize)
273 {
274 delete[] m_data;
275 m_data = new uint8_t[dataSize];
276 m_dataSize = dataSize;
277 }
278
279 if (fillSize >= dataSize)
280 {
281 memcpy(m_data, fill, dataSize);
282 m_size = dataSize;
283 return;
284 }
285
286 //
287 // Do all but the final fill.
288 //
289 uint32_t filled = 0;
290 while (filled + fillSize < dataSize)
291 {
292 memcpy(&m_data[filled], fill, fillSize);
293 filled += fillSize;
294 }
295
296 //
297 // Last fill may be partial
298 //
299 memcpy(&m_data[filled], fill, dataSize - filled);
300
301 //
302 // Overwrite packet size attribute.
303 //
304 m_size = dataSize;
305}
306
307void
309{
310 NS_LOG_FUNCTION(this << dt);
312}
313
314void
316{
317 NS_LOG_FUNCTION(this);
318
320
321 Ptr<Packet> p;
322 if (m_dataSize)
323 {
324 //
325 // If m_dataSize is non-zero, we have a data buffer of the same size that we
326 // are expected to copy and send. This state of affairs is created if one of
327 // the Fill functions is called. In this case, m_size must have been set
328 // to agree with m_dataSize
329 //
331 "UdpEchoClient::Send(): m_size and m_dataSize inconsistent");
332 NS_ASSERT_MSG(m_data, "UdpEchoClient::Send(): m_dataSize but no m_data");
333 p = Create<Packet>(m_data, m_dataSize);
334 }
335 else
336 {
337 //
338 // If m_dataSize is zero, the client has indicated that it doesn't care
339 // about the data itself either by specifying the data size by setting
340 // the corresponding attribute or by not calling a SetFill function. In
341 // this case, we don't worry about it either. But we do allow m_size
342 // to have a value different from the (zero) m_dataSize.
343 //
344 p = Create<Packet>(m_size);
345 }
346 Address localAddress;
347 m_socket->GetSockName(localAddress);
348 // call to the trace sinks before the packet is actually sent,
349 // so that tags added to the packet can be sent as well
350 m_txTrace(p);
352 {
354 p,
355 localAddress,
357 }
359 {
361 p,
362 localAddress,
364 }
365 m_socket->Send(p);
366 ++m_sent;
367
369 {
370 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " client sent " << m_size
371 << " bytes to " << Ipv4Address::ConvertFrom(m_peerAddress)
372 << " port " << m_peerPort);
373 }
375 {
376 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " client sent " << m_size
377 << " bytes to " << Ipv6Address::ConvertFrom(m_peerAddress)
378 << " port " << m_peerPort);
379 }
381 {
383 "At time " << Simulator::Now().As(Time::S) << " client sent " << m_size << " bytes to "
384 << InetSocketAddress::ConvertFrom(m_peerAddress).GetIpv4() << " port "
386 }
388 {
390 "At time " << Simulator::Now().As(Time::S) << " client sent " << m_size << " bytes to "
391 << Inet6SocketAddress::ConvertFrom(m_peerAddress).GetIpv6() << " port "
393 }
394
395 if (m_sent < m_count || m_count == 0)
396 {
398 }
399}
400
401void
403{
404 NS_LOG_FUNCTION(this << socket);
405 Ptr<Packet> packet;
406 Address from;
407 Address localAddress;
408 while ((packet = socket->RecvFrom(from)))
409 {
411 {
412 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " client received "
413 << packet->GetSize() << " bytes from "
414 << InetSocketAddress::ConvertFrom(from).GetIpv4() << " port "
416 }
418 {
419 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " client received "
420 << packet->GetSize() << " bytes from "
421 << Inet6SocketAddress::ConvertFrom(from).GetIpv6() << " port "
423 }
424 socket->GetSockName(localAddress);
425 m_rxTrace(packet);
426 m_rxTraceWithAddresses(packet, from, localAddress);
427 }
428}
429
430} // Namespace ns3
a polymophic address class
Definition: address.h:100
AttributeValue implementation for Address.
The base class for all ns3 applications.
Definition: application.h:61
void DoDispose() override
Destructor implementation.
Definition: application.cc:85
Ptr< Node > GetNode() const
Definition: application.cc:107
An identifier for simulation events.
Definition: event-id.h:55
bool IsExpired() const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:69
An Inet6 address class.
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
uint16_t GetPort() const
Get the port.
static bool IsMatchingType(const Address &addr)
If the address match.
Ipv6Address GetIpv6() const
Get the IPv6 address.
an Inet address class
static bool IsMatchingType(const Address &address)
Ipv4Address GetIpv4() const
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
static Ipv4Address ConvertFrom(const Address &address)
static bool IsMatchingType(const Address &address)
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.
static bool IsMatchingType(const Address &address)
If the Address matches the type.
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:863
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:568
static void Cancel(const EventId &id)
Set the cancel bit on this event: the event's associated function will not be invoked when it expires...
Definition: simulator.cc:276
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:199
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
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.
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual int GetSockName(Address &address) const =0
Get socket address.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:126
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 int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
@ S
second
Definition: nstime.h:116
AttributeValue implementation for Time.
Definition: nstime.h:1423
a unique identifier for an interface.
Definition: type-id.h:60
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:839
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:935
A Udp Echo client.
void SetFill(std::string fill)
Set the data fill of the packet (what is sent as data to the server) to the zero-terminated contents ...
Time m_interval
Packet inter-send time.
void DoDispose() override
Destructor implementation.
void Send()
Send a packet.
void StopApplication() override
Application specific shutdown code.
Ptr< Socket > m_socket
Socket.
void HandleRead(Ptr< Socket > socket)
Handle a packet reception.
EventId m_sendEvent
Event to send the next packet.
uint32_t m_size
Size of the sent packet.
uint32_t GetDataSize() const
Get the number of data bytes that will be sent to the server.
uint32_t m_count
Maximum number of packets the application will send.
static TypeId GetTypeId()
Get the type ID.
Address m_peerAddress
Remote peer address.
uint8_t * m_data
packet payload data
uint32_t m_sent
Counter for sent packets.
void StartApplication() override
Application specific startup code.
void ScheduleTransmit(Time dt)
Schedule the next packet transmission.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
TracedCallback< Ptr< const Packet > > m_txTrace
Callbacks for tracing the packet Tx events.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
Callbacks for tracing the packet Rx events, includes source and destination addresses.
void SetDataSize(uint32_t dataSize)
Set the data size of the packet (the number of bytes that are sent as data to the server).
uint16_t m_peerPort
Remote peer port.
TracedCallback< Ptr< const Packet > > m_rxTrace
Callbacks for tracing the packet Rx events.
uint32_t m_dataSize
packet payload size (must be equal to m_size)
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Hold an unsigned integer type.
Definition: uinteger.h:45
uint16_t port
Definition: dsdv-manet.cc:45
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Definition: nstime.h:1424
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:46
Callback< R, Args... > MakeNullCallback()
Definition: callback.h:734
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:160
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1336
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
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:691
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:535