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,1500))
72  ;
73  return tid;
74 }
75 
77 {
78  NS_LOG_FUNCTION (this);
79  m_sent = 0;
80  m_socket = 0;
81  m_sendEvent = EventId ();
82 }
83 
85 {
86  NS_LOG_FUNCTION (this);
87 }
88 
89 void
91 {
92  NS_LOG_FUNCTION (this << ip << port);
93  m_peerAddress = Address(ip);
94  m_peerPort = port;
95 }
96 
97 void
99 {
100  NS_LOG_FUNCTION (this << ip << port);
101  m_peerAddress = Address(ip);
102  m_peerPort = port;
103 }
104 
105 void
107 {
108  NS_LOG_FUNCTION (this << ip << port);
109  m_peerAddress = ip;
110  m_peerPort = port;
111 }
112 
113 void
115 {
116  NS_LOG_FUNCTION (this);
118 }
119 
120 void
122 {
123  NS_LOG_FUNCTION (this);
124 
125  if (m_socket == 0)
126  {
127  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
130  {
131  m_socket->Bind ();
133  }
134  else if (Ipv6Address::IsMatchingType(m_peerAddress) == true)
135  {
136  m_socket->Bind6 ();
138  }
139  }
140 
142  m_socket->SetAllowBroadcast (true);
144 }
145 
146 void
148 {
149  NS_LOG_FUNCTION (this);
151 }
152 
153 void
155 {
156  NS_LOG_FUNCTION (this);
158  SeqTsHeader seqTs;
159  seqTs.SetSeq (m_sent);
160  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
161  p->AddHeader (seqTs);
162 
163  std::stringstream peerAddressStringStream;
165  {
166  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
167  }
169  {
170  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
171  }
172 
173  if ((m_socket->Send (p)) >= 0)
174  {
175  ++m_sent;
176  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
177  << peerAddressStringStream.str () << " Uid: "
178  << p->GetUid () << " Time: "
179  << (Simulator::Now ()).GetSeconds ());
180 
181  }
182  else
183  {
184  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
185  << peerAddressStringStream.str ());
186  }
187 
188  if (m_sent < m_count)
189  {
191  }
192 }
193 
194 } // 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.
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:88
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-client.cc:121
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:368
#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: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:1626
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:147
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:446
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
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1216
The base class for all ns3 applications.
Definition: application.h:60
AttributeValue implementation for Time.
Definition: nstime.h:957
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:104
An Inet6 address class.
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
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:154
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:83
virtual ~UdpClient()
Definition: udp-client.cc:84
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.
A Udp client.
Definition: udp-client.h:43
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:958
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
Describes an IPv6 address.
Definition: ipv6-address.h:48
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:895
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:114
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:90
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:826
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:257
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:96
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:751
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.