A Discrete-Event Network Simulator
API
udp-client.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2007,2008,2009 INRIA, UDCAST
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 * Author: Amine Ismail <amine.ismail@sophia.inria.fr>
18 * <amine.ismail@udcast.com>
19 */
20#include "udp-client.h"
21
22#include "seq-ts-header.h"
23
24#include "ns3/inet-socket-address.h"
25#include "ns3/inet6-socket-address.h"
26#include "ns3/ipv4-address.h"
27#include "ns3/log.h"
28#include "ns3/nstime.h"
29#include "ns3/packet.h"
30#include "ns3/simulator.h"
31#include "ns3/socket-factory.h"
32#include "ns3/socket.h"
33#include "ns3/uinteger.h"
34
35#include <cstdio>
36#include <cstdlib>
37
38namespace ns3
39{
40
41NS_LOG_COMPONENT_DEFINE("UdpClient");
42
44
45TypeId
47{
48 static TypeId tid =
49 TypeId("ns3::UdpClient")
51 .SetGroupName("Applications")
52 .AddConstructor<UdpClient>()
53 .AddAttribute(
54 "MaxPackets",
55 "The maximum number of packets the application will send (zero means infinite)",
56 UintegerValue(100),
58 MakeUintegerChecker<uint32_t>())
59 .AddAttribute("Interval",
60 "The time to wait between packets",
61 TimeValue(Seconds(1.0)),
64 .AddAttribute("RemoteAddress",
65 "The destination Address of the outbound packets",
67 MakeAddressAccessor(&UdpClient::m_peerAddress),
68 MakeAddressChecker())
69 .AddAttribute("RemotePort",
70 "The destination port of the outbound packets",
71 UintegerValue(100),
73 MakeUintegerChecker<uint16_t>())
74 .AddAttribute("PacketSize",
75 "Size of packets generated. The minimum packet size is 12 bytes which is "
76 "the size of the header carrying the sequence number and the time stamp.",
77 UintegerValue(1024),
79 MakeUintegerChecker<uint32_t>(12, 65507));
80 return tid;
81}
82
84{
85 NS_LOG_FUNCTION(this);
86 m_sent = 0;
87 m_totalTx = 0;
88 m_socket = nullptr;
90}
91
93{
94 NS_LOG_FUNCTION(this);
95}
96
97void
99{
100 NS_LOG_FUNCTION(this << ip << port);
101 m_peerAddress = ip;
103}
104
105void
107{
108 NS_LOG_FUNCTION(this << addr);
109 m_peerAddress = addr;
110}
111
112void
114{
115 NS_LOG_FUNCTION(this);
117}
118
119void
121{
122 NS_LOG_FUNCTION(this);
123
124 if (!m_socket)
125 {
126 TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
129 {
130 if (m_socket->Bind() == -1)
131 {
132 NS_FATAL_ERROR("Failed to bind socket");
133 }
136 }
138 {
139 if (m_socket->Bind6() == -1)
140 {
141 NS_FATAL_ERROR("Failed to bind socket");
142 }
145 }
147 {
148 if (m_socket->Bind() == -1)
149 {
150 NS_FATAL_ERROR("Failed to bind socket");
151 }
153 }
155 {
156 if (m_socket->Bind6() == -1)
157 {
158 NS_FATAL_ERROR("Failed to bind socket");
159 }
161 }
162 else
163 {
164 NS_ASSERT_MSG(false, "Incompatible address type: " << m_peerAddress);
165 }
166 }
167
168#ifdef NS3_LOG_ENABLE
169 std::stringstream peerAddressStringStream;
171 {
172 peerAddressStringStream << Ipv4Address::ConvertFrom(m_peerAddress);
173 }
175 {
176 peerAddressStringStream << Ipv6Address::ConvertFrom(m_peerAddress);
177 }
179 {
180 peerAddressStringStream << InetSocketAddress::ConvertFrom(m_peerAddress).GetIpv4();
181 }
183 {
184 peerAddressStringStream << Inet6SocketAddress::ConvertFrom(m_peerAddress).GetIpv6();
185 }
186 m_peerAddressString = peerAddressStringStream.str();
187#endif // NS3_LOG_ENABLE
188
192}
193
194void
196{
197 NS_LOG_FUNCTION(this);
199}
200
201void
203{
204 NS_LOG_FUNCTION(this);
206 SeqTsHeader seqTs;
207 seqTs.SetSeq(m_sent);
208 Ptr<Packet> p = Create<Packet>(m_size - (8 + 4)); // 8+4 : the size of the seqTs header
209 p->AddHeader(seqTs);
210
211 if ((m_socket->Send(p)) >= 0)
212 {
213 ++m_sent;
214 m_totalTx += p->GetSize();
215#ifdef NS3_LOG_ENABLE
216 NS_LOG_INFO("TraceDelay TX " << m_size << " bytes to " << m_peerAddressString << " Uid: "
217 << p->GetUid() << " Time: " << (Simulator::Now()).As(Time::S));
218#endif // NS3_LOG_ENABLE
219 }
220#ifdef NS3_LOG_ENABLE
221 else
222 {
223 NS_LOG_INFO("Error while sending " << m_size << " bytes to " << m_peerAddressString);
224 }
225#endif // NS3_LOG_ENABLE
226
227 if (m_sent < m_count || m_count == 0)
228 {
230 }
231}
232
233uint64_t
235{
236 return m_totalTx;
237}
238
239} // 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.
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.
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:268
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:863
uint64_t GetUid() const
Returns the packet's Uid.
Definition: packet.cc:412
Packet header to carry sequence number and timestamp.
Definition: seq-ts-header.h:45
void SetSeq(uint32_t seq)
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 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.
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 Bind(const Address &address)=0
Allocate a local endpoint for this socket.
@ 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 client.
Definition: udp-client.h:44
Time m_interval
Packet inter-send time.
Definition: udp-client.h:86
void DoDispose() override
Destructor implementation.
Definition: udp-client.cc:113
uint64_t GetTotalTx() const
Definition: udp-client.cc:234
uint64_t m_totalTx
Total bytes sent.
Definition: udp-client.h:90
~UdpClient() override
Definition: udp-client.cc:92
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:89
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:91
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:93
void Send()
Send a packet.
Definition: udp-client.cc:202
static TypeId GetTypeId()
Get the type ID.
Definition: udp-client.cc:46
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:94
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:87
uint32_t m_count
Maximum number of packets the application will send.
Definition: udp-client.h:85
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:98
Address m_peerAddress
Remote peer address.
Definition: udp-client.h:92
void StartApplication() override
Application specific startup code.
Definition: udp-client.cc:120
void StopApplication() override
Application specific shutdown code.
Definition: udp-client.cc:195
std::string m_peerAddressString
Remote peer address string.
Definition: udp-client.h:96
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
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:535