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_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 = ip;
94  m_peerPort = port;
95 }
96 
97 void
99 {
100  NS_LOG_FUNCTION (this << addr);
101  m_peerAddress = addr;
102 }
103 
104 void
106 {
107  NS_LOG_FUNCTION (this);
109 }
110 
111 void
113 {
114  NS_LOG_FUNCTION (this);
115 
116  if (m_socket == 0)
117  {
118  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
121  {
122  if (m_socket->Bind () == -1)
123  {
124  NS_FATAL_ERROR ("Failed to bind socket");
125  }
127  }
128  else if (Ipv6Address::IsMatchingType(m_peerAddress) == true)
129  {
130  if (m_socket->Bind6 () == -1)
131  {
132  NS_FATAL_ERROR ("Failed to bind socket");
133  }
135  }
137  {
138  if (m_socket->Bind () == -1)
139  {
140  NS_FATAL_ERROR ("Failed to bind socket");
141  }
143  }
145  {
146  if (m_socket->Bind6 () == -1)
147  {
148  NS_FATAL_ERROR ("Failed to bind socket");
149  }
151  }
152  else
153  {
154  NS_ASSERT_MSG (false, "Incompatible address type: " << m_peerAddress);
155  }
156  }
157 
159  m_socket->SetAllowBroadcast (true);
161 }
162 
163 void
165 {
166  NS_LOG_FUNCTION (this);
168 }
169 
170 void
172 {
173  NS_LOG_FUNCTION (this);
175  SeqTsHeader seqTs;
176  seqTs.SetSeq (m_sent);
177  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
178  p->AddHeader (seqTs);
179 
180  std::stringstream peerAddressStringStream;
182  {
183  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
184  }
186  {
187  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
188  }
189 
190  if ((m_socket->Send (p)) >= 0)
191  {
192  ++m_sent;
193  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
194  << peerAddressStringStream.str () << " Uid: "
195  << p->GetUid () << " Time: "
196  << (Simulator::Now ()).GetSeconds ());
197 
198  }
199  else
200  {
201  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
202  << peerAddressStringStream.str ());
203  }
204 
205  if (m_sent < m_count)
206  {
208  }
209 }
210 
211 } // Namespace ns3
static bool IsMatchingType(const Address &address)
If the Address matches the type.
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
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
NS_ASSERT_MSG(false, "Ipv4AddressGenerator::MaskToIndex(): Impossible")
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:81
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-client.cc:112
#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
#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:162
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:290
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:86
Callback< R > MakeNullCallback(void)
Definition: callback.h:1786
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:164
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:59
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:90
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:85
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:449
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:83
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:1390
The base class for all ns3 applications.
Definition: application.h:60
AttributeValue implementation for Time.
Definition: nstime.h:1132
Time m_interval
Packet inter-send time.
Definition: udp-client.h:82
Hold an unsigned integer type.
Definition: uinteger.h:44
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:88
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:171
static bool IsMatchingType(const Address &address)
Ptr< Node > GetNode() const
Definition: application.cc:104
Packet header for UDP client/server application.
Definition: seq-ts-header.h:37
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:87
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:1133
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:193
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:1070
static bool IsMatchingType(const Address &addr)
If the address match.
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:105
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
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:89
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.