A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 NS_OBJECT_ENSURE_REGISTERED (UdpClient);
40 
41 TypeId
43 {
44  static TypeId tid = TypeId ("ns3::UdpClient")
46  .AddConstructor<UdpClient> ()
47  .AddAttribute ("MaxPackets",
48  "The maximum number of packets the application will send",
49  UintegerValue (100),
50  MakeUintegerAccessor (&UdpClient::m_count),
51  MakeUintegerChecker<uint32_t> ())
52  .AddAttribute ("Interval",
53  "The time to wait between packets", TimeValue (Seconds (1.0)),
54  MakeTimeAccessor (&UdpClient::m_interval),
55  MakeTimeChecker ())
56  .AddAttribute ("RemoteAddress",
57  "The destination Address of the outbound packets",
58  AddressValue (),
59  MakeAddressAccessor (&UdpClient::m_peerAddress),
60  MakeAddressChecker ())
61  .AddAttribute ("RemotePort", "The destination port of the outbound packets",
62  UintegerValue (100),
63  MakeUintegerAccessor (&UdpClient::m_peerPort),
64  MakeUintegerChecker<uint16_t> ())
65  .AddAttribute ("PacketSize",
66  "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.",
67  UintegerValue (1024),
68  MakeUintegerAccessor (&UdpClient::m_size),
69  MakeUintegerChecker<uint32_t> (12,1500))
70  ;
71  return tid;
72 }
73 
75 {
76  NS_LOG_FUNCTION (this);
77  m_sent = 0;
78  m_socket = 0;
79  m_sendEvent = EventId ();
80 }
81 
83 {
84  NS_LOG_FUNCTION (this);
85 }
86 
87 void
89 {
90  NS_LOG_FUNCTION (this << ip << port);
91  m_peerAddress = Address(ip);
92  m_peerPort = port;
93 }
94 
95 void
97 {
98  NS_LOG_FUNCTION (this << ip << port);
99  m_peerAddress = Address(ip);
100  m_peerPort = port;
101 }
102 
103 void
105 {
106  NS_LOG_FUNCTION (this << ip << port);
107  m_peerAddress = ip;
108  m_peerPort = port;
109 }
110 
111 void
113 {
114  NS_LOG_FUNCTION (this);
116 }
117 
118 void
120 {
121  NS_LOG_FUNCTION (this);
122 
123  if (m_socket == 0)
124  {
125  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
128  {
129  m_socket->Bind ();
131  }
132  else if (Ipv6Address::IsMatchingType(m_peerAddress) == true)
133  {
134  m_socket->Bind6 ();
136  }
137  }
138 
140  m_sendEvent = Simulator::Schedule (Seconds (0.0), &UdpClient::Send, this);
141 }
142 
143 void
145 {
146  NS_LOG_FUNCTION (this);
148 }
149 
150 void
152 {
153  NS_LOG_FUNCTION (this);
155  SeqTsHeader seqTs;
156  seqTs.SetSeq (m_sent);
157  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
158  p->AddHeader (seqTs);
159 
160  std::stringstream peerAddressStringStream;
162  {
163  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
164  }
166  {
167  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
168  }
169 
170  if ((m_socket->Send (p)) >= 0)
171  {
172  ++m_sent;
173  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
174  << peerAddressStringStream.str () << " Uid: "
175  << p->GetUid () << " Time: "
176  << (Simulator::Now ()).GetSeconds ());
177 
178  }
179  else
180  {
181  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
182  << peerAddressStringStream.str ());
183  }
184 
185  if (m_sent < m_count)
186  {
188  }
189 }
190 
191 } // 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 the class in the ns-3 factory.
Definition: object-base.h:38
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:119
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:393
#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:170
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:223
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
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:93
Callback< R > MakeNullCallback(void)
Definition: callback.h:1399
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:825
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:144
uint16_t port
Definition: dsdv-manet.cc:44
a polymophic address class
Definition: address.h:86
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:92
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:90
The base class for all ns3 applications.
Definition: application.h:60
hold objects of type ns3::Time
Definition: nstime.h:1008
Time m_interval
Packet inter-send time.
Definition: udp-client.h:89
Hold an unsigned integer type.
Definition: uinteger.h:46
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:42
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:151
static bool IsMatchingType(const Address &address)
Doxygen 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)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: application.cc:82
virtual ~UdpClient()
Definition: udp-client.cc:82
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.
static Time Now(void)
Return the "current simulation time".
Definition: simulator.cc:180
Describes an IPv6 address.
Definition: ipv6-address.h:46
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
hold objects of type ns3::Address
an identifier for simulation events.
Definition: event-id.h:46
void SetSeq(uint32_t seq)
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:441
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)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: udp-client.cc:112
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::isExpired method.
Definition: event-id.cc:53
void SetRemote(Ipv4Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:88
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
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:535
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.