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 
36 namespace ns3 {
37 
38 NS_LOG_COMPONENT_DEFINE ("UdpClient");
39 
40 NS_OBJECT_ENSURE_REGISTERED (UdpClient);
41 
42 TypeId
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)),
57  MakeTimeChecker ())
58  .AddAttribute ("RemoteAddress",
59  "The destination Address of the outbound packets",
60  AddressValue (),
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;
82  m_sendEvent = EventId ();
83 }
84 
86 {
87  NS_LOG_FUNCTION (this);
88 }
89 
90 void
92 {
93  NS_LOG_FUNCTION (this << ip << port);
94  m_peerAddress = ip;
95  m_peerPort = port;
96 }
97 
98 void
100 {
101  NS_LOG_FUNCTION (this << addr);
102  m_peerAddress = addr;
103 }
104 
105 void
107 {
108  NS_LOG_FUNCTION (this);
110 }
111 
112 void
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  }
129  else if (Ipv6Address::IsMatchingType(m_peerAddress) == true)
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 
160  m_socket->SetAllowBroadcast (true);
162 }
163 
164 void
166 {
167  NS_LOG_FUNCTION (this);
169 }
170 
171 void
173 {
174  NS_LOG_FUNCTION (this);
176  SeqTsHeader seqTs;
177  seqTs.SetSeq (m_sent);
178  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
179  p->AddHeader (seqTs);
180 
181  std::stringstream peerAddressStringStream;
183  {
184  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
185  }
187  {
188  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
189  }
190 
191  if ((m_socket->Send (p)) >= 0)
192  {
193  ++m_sent;
194  m_totalTx += p->GetSize ();
195  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
196  << peerAddressStringStream.str () << " Uid: "
197  << p->GetUid () << " Time: "
198  << (Simulator::Now ()).As (Time::S));
199 
200  }
201  else
202  {
203  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
204  << peerAddressStringStream.str ());
205  }
206 
207  if (m_sent < m_count)
208  {
210  }
211 }
212 
213 
214 uint64_t
216 {
217  return m_totalTx;
218 }
219 
220 
221 } // Namespace ns3
static bool IsMatchingType(const Address &address)
If the Address matches the type.
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:557
uint64_t GetUid(void) const
Returns the packet&#39;s Uid.
Definition: packet.cc:390
an Inet address class
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:852
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
uint32_t m_count
Maximum number of packets the application will send.
Definition: udp-client.h:86
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-client.cc:113
#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_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
uint64_t GetTotalTx() const
Definition: udp-client.cc:215
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
static void Cancel(const EventId &id)
Set the cancel bit on this event: the event&#39;s associated function will not be invoked when it expires...
Definition: simulator.cc:268
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:92
Callback< R, Ts... > MakeNullCallback(void)
Definition: callback.h:1682
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:165
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:65
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:91
uint16_t port
Definition: dsdv-manet.cc:45
a polymophic address class
Definition: address.h:90
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:90
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:88
uint64_t m_totalTx
Total bytes sent.
Definition: udp-client.h:91
Ptr< const AttributeAccessor > MakeAddressAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: address.h:278
The base class for all ns3 applications.
Definition: application.h:60
AttributeValue implementation for Time.
Definition: nstime.h:1353
Time m_interval
Packet inter-send time.
Definition: udp-client.h:87
Hold an unsigned integer type.
Definition: uinteger.h:44
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:94
An Inet6 address class.
static TypeId GetTypeId(void)
Get the type ID.
Definition: udp-client.cc:43
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
void Send(void)
Send a packet.
Definition: udp-client.cc:172
static bool IsMatchingType(const Address &address)
Ptr< Node > GetNode() const
Definition: application.cc:104
Packet header to carry sequence number and timestamp.
Definition: seq-ts-header.h:44
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
virtual ~UdpClient()
Definition: udp-client.cc:85
Address m_peerAddress
Remote peer address.
Definition: udp-client.h:93
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:128
Every class exported by the ns3 library is enclosed in the ns3 namespace.
A Udp client.
Definition: udp-client.h:43
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:1354
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
#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
AttributeValue implementation for Address.
Definition: address.h:278
An identifier for simulation events.
Definition: event-id.h:53
void SetSeq(uint32_t seq)
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1289
static bool IsMatchingType(const Address &addr)
If the address match.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:533
second
Definition: nstime.h:115
static Ipv4Address ConvertFrom(const Address &address)
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual void DoDispose(void)
Destructor implementation.
Definition: udp-client.cc:106
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: uinteger.h:45
a unique identifier for an interface.
Definition: type-id.h:58
Ptr< const AttributeChecker > MakeAddressChecker(void)
Definition: address.cc:172
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923
static bool IsMatchingType(const Address &address)
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:256
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:95
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:830
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.