A Discrete-Event Network Simulator
API
udp-client.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2007,2008,2009 INRIA, UDCAST
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: Amine Ismail <amine.ismail@sophia.inria.fr>
19 * <amine.ismail@udcast.com>
20 */
21#include "ns3/log.h"
22#include "ns3/ipv4-address.h"
23#include "ns3/nstime.h"
24#include "ns3/inet-socket-address.h"
25#include "ns3/inet6-socket-address.h"
26#include "ns3/socket.h"
27#include "ns3/simulator.h"
28#include "ns3/socket-factory.h"
29#include "ns3/packet.h"
30#include "ns3/uinteger.h"
31#include "udp-client.h"
32#include "seq-ts-header.h"
33#include <cstdlib>
34#include <cstdio>
35
36namespace ns3 {
37
38NS_LOG_COMPONENT_DEFINE ("UdpClient");
39
41
42TypeId
44{
45 static TypeId tid = TypeId ("ns3::UdpClient")
47 .SetGroupName("Applications")
48 .AddConstructor<UdpClient> ()
49 .AddAttribute ("MaxPackets",
50 "The maximum number of packets the application will send",
51 UintegerValue (100),
53 MakeUintegerChecker<uint32_t> ())
54 .AddAttribute ("Interval",
55 "The time to wait between packets", TimeValue (Seconds (1.0)),
58 .AddAttribute ("RemoteAddress",
59 "The destination Address of the outbound packets",
60 AddressValue (),
61 MakeAddressAccessor (&UdpClient::m_peerAddress),
62 MakeAddressChecker ())
63 .AddAttribute ("RemotePort", "The destination port of the outbound packets",
64 UintegerValue (100),
66 MakeUintegerChecker<uint16_t> ())
67 .AddAttribute ("PacketSize",
68 "Size of packets generated. The minimum packet size is 12 bytes which is the size of the header carrying the sequence number and the time stamp.",
69 UintegerValue (1024),
71 MakeUintegerChecker<uint32_t> (12,65507))
72 ;
73 return tid;
74}
75
77{
78 NS_LOG_FUNCTION (this);
79 m_sent = 0;
80 m_totalTx = 0;
81 m_socket = 0;
83}
84
86{
87 NS_LOG_FUNCTION (this);
88}
89
90void
92{
93 NS_LOG_FUNCTION (this << ip << port);
94 m_peerAddress = ip;
96}
97
98void
100{
101 NS_LOG_FUNCTION (this << addr);
102 m_peerAddress = addr;
103}
104
105void
107{
108 NS_LOG_FUNCTION (this);
110}
111
112void
114{
115 NS_LOG_FUNCTION (this);
116
117 if (m_socket == 0)
118 {
119 TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
122 {
123 if (m_socket->Bind () == -1)
124 {
125 NS_FATAL_ERROR ("Failed to bind socket");
126 }
128 }
130 {
131 if (m_socket->Bind6 () == -1)
132 {
133 NS_FATAL_ERROR ("Failed to bind socket");
134 }
136 }
138 {
139 if (m_socket->Bind () == -1)
140 {
141 NS_FATAL_ERROR ("Failed to bind socket");
142 }
144 }
146 {
147 if (m_socket->Bind6 () == -1)
148 {
149 NS_FATAL_ERROR ("Failed to bind socket");
150 }
152 }
153 else
154 {
155 NS_ASSERT_MSG (false, "Incompatible address type: " << m_peerAddress);
156 }
157 }
158
159#ifdef NS3_LOG_ENABLE
160 std::stringstream peerAddressStringStream;
162 {
163 peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
164 }
166 {
167 peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
168 }
170 {
171 peerAddressStringStream << InetSocketAddress::ConvertFrom (m_peerAddress).GetIpv4 ();
172 }
174 {
175 peerAddressStringStream << Inet6SocketAddress::ConvertFrom (m_peerAddress).GetIpv6 ();
176 }
177 m_peerAddressString = peerAddressStringStream.str();
178#endif // NS3_LOG_ENABLE
179
183}
184
185void
187{
188 NS_LOG_FUNCTION (this);
190}
191
192void
194{
195 NS_LOG_FUNCTION (this);
197 SeqTsHeader seqTs;
198 seqTs.SetSeq (m_sent);
199 Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
200 p->AddHeader (seqTs);
201
202 if ((m_socket->Send (p)) >= 0)
203 {
204 ++m_sent;
205 m_totalTx += p->GetSize ();
206#ifdef NS3_LOG_ENABLE
207 NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
208 << m_peerAddressString << " Uid: "
209 << p->GetUid () << " Time: "
210 << (Simulator::Now ()).As (Time::S));
211#endif // NS3_LOG_ENABLE
212 }
213#ifdef NS3_LOG_ENABLE
214 else
215 {
216 NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
218 }
219#endif // NS3_LOG_ENABLE
220
221 if (m_sent < m_count)
222 {
224 }
225}
226
227
228uint64_t
230{
231 return m_totalTx;
232}
233
234
235} // Namespace ns3
a polymophic address class
Definition: address.h:91
AttributeValue implementation for Address.
The base class for all ns3 applications.
Definition: application.h:61
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
Ptr< Node > GetNode() const
Definition: application.cc:104
An identifier for simulation events.
Definition: event-id.h:54
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:65
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(void) const
Get the IPv6 address.
an Inet address class
Ipv4Address GetIpv4(void) const
static bool IsMatchingType(const Address &address)
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:256
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:390
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:856
Packet header to carry sequence number and timestamp.
Definition: seq-ts-header.h:45
void SetSeq(uint32_t seq)
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:268
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:556
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
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:128
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:71
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
@ S
second
Definition: nstime.h:114
AttributeValue implementation for Time.
Definition: nstime.h:1308
a unique identifier for an interface.
Definition: type-id.h:59
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:829
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
A Udp client.
Definition: udp-client.h:44
Time m_interval
Packet inter-send time.
Definition: udp-client.h:87
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-client.cc:113
uint64_t GetTotalTx() const
Definition: udp-client.cc:229
uint64_t m_totalTx
Total bytes sent.
Definition: udp-client.h:91
void Send(void)
Send a packet.
Definition: udp-client.cc:193
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:90
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:92
virtual void DoDispose(void)
Destructor implementation.
Definition: udp-client.cc:106
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:94
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:95
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:88
uint32_t m_count
Maximum number of packets the application will send.
Definition: udp-client.h:86
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:91
Address m_peerAddress
Remote peer address.
Definition: udp-client.h:93
virtual ~UdpClient()
Definition: udp-client.cc:85
static TypeId GetTypeId(void)
Get the type ID.
Definition: udp-client.cc:43
std::string m_peerAddressString
Remote peer address string.
Definition: udp-client.h:97
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:186
Hold an unsigned integer type.
Definition: uinteger.h:44
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:67
#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:88
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Definition: nstime.h:1309
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:45
Callback< R, Ts... > MakeNullCallback(void)
Definition: callback.h:1688
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#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:281
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
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:522