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  .AddConstructor<UdpClient> ()
48  .AddAttribute ("MaxPackets",
49  "The maximum number of packets the application will send",
50  UintegerValue (100),
52  MakeUintegerChecker<uint32_t> ())
53  .AddAttribute ("Interval",
54  "The time to wait between packets", TimeValue (Seconds (1.0)),
56  MakeTimeChecker ())
57  .AddAttribute ("RemoteAddress",
58  "The destination Address of the outbound packets",
59  AddressValue (),
62  .AddAttribute ("RemotePort", "The destination port of the outbound packets",
63  UintegerValue (100),
65  MakeUintegerChecker<uint16_t> ())
66  .AddAttribute ("PacketSize",
67  "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.",
68  UintegerValue (1024),
70  MakeUintegerChecker<uint32_t> (12,1500))
71  ;
72  return tid;
73 }
74 
76 {
77  NS_LOG_FUNCTION (this);
78  m_sent = 0;
79  m_socket = 0;
80  m_sendEvent = EventId ();
81 }
82 
84 {
85  NS_LOG_FUNCTION (this);
86 }
87 
88 void
90 {
91  NS_LOG_FUNCTION (this << ip << port);
92  m_peerAddress = Address(ip);
93  m_peerPort = port;
94 }
95 
96 void
98 {
99  NS_LOG_FUNCTION (this << ip << port);
100  m_peerAddress = Address(ip);
101  m_peerPort = port;
102 }
103 
104 void
106 {
107  NS_LOG_FUNCTION (this << ip << port);
108  m_peerAddress = ip;
109  m_peerPort = port;
110 }
111 
112 void
114 {
115  NS_LOG_FUNCTION (this);
117 }
118 
119 void
121 {
122  NS_LOG_FUNCTION (this);
123 
124  if (m_socket == 0)
125  {
126  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
129  {
130  m_socket->Bind ();
132  }
133  else if (Ipv6Address::IsMatchingType(m_peerAddress) == true)
134  {
135  m_socket->Bind6 ();
137  }
138  }
139 
142 }
143 
144 void
146 {
147  NS_LOG_FUNCTION (this);
149 }
150 
151 void
153 {
154  NS_LOG_FUNCTION (this);
156  SeqTsHeader seqTs;
157  seqTs.SetSeq (m_sent);
158  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
159  p->AddHeader (seqTs);
160 
161  std::stringstream peerAddressStringStream;
163  {
164  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
165  }
167  {
168  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
169  }
170 
171  if ((m_socket->Send (p)) >= 0)
172  {
173  ++m_sent;
174  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
175  << peerAddressStringStream.str () << " Uid: "
176  << p->GetUid () << " Time: "
177  << (Simulator::Now ()).GetSeconds ());
178 
179  }
180  else
181  {
182  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
183  << peerAddressStringStream.str ());
184  }
185 
186  if (m_sent < m_count)
187  {
189  }
190 }
191 
192 } // Namespace ns3
static bool IsMatchingType(const Address &address)
If the Address matches the type.
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:44
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
uint32_t m_count
Maximum number of packets the application will send.
Definition: udp-client.h:88
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-client.cc:120
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:380
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:244
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:311
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:93
Callback< R > MakeNullCallback(void)
Definition: callback.h:1436
static EventId Schedule(Time const &time, MEM mem_ptr, OBJ obj)
Schedule an event to expire at the relative time "time" is reached.
Definition: simulator.h:819
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:145
uint16_t port
Definition: dsdv-manet.cc:44
a polymophic address class
Definition: address.h:90
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:92
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:439
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:90
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:921
Time m_interval
Packet inter-send time.
Definition: udp-client.h:89
Hold an unsigned integer type.
Definition: uinteger.h:44
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:95
Ptr< Node > GetNode() const
Definition: application.cc:103
An Inet6 address class.
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:127
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:70
void Send(void)
Send a packet.
Definition: udp-client.cc:152
static bool IsMatchingType(const Address &address)
Introspection did not find any typical Config paths.
Definition: seq-ts-header.h:36
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:82
virtual ~UdpClient()
Definition: udp-client.cc:83
Address m_peerAddress
Remote peer address.
Definition: udp-client.h:94
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeAddressChecker(void)
Definition: address.cc:172
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:922
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
Describes an IPv6 address.
Definition: ipv6-address.h:47
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
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:859
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:113
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:59
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
void SetRemote(Ipv4Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:89
a unique identifier for an interface.
Definition: type-id.h:51
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:253
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:96
static TypeId LookupByName(std::string name)
Definition: type-id.cc:556
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.