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  ;
41  ;
42 
43 TypeId
45 {
46  static TypeId tid = TypeId ("ns3::UdpClient")
48  .AddConstructor<UdpClient> ()
49  .AddAttribute ("MaxPackets",
50  "The maximum number of packets the application will send",
51  UintegerValue (100),
52  MakeUintegerAccessor (&UdpClient::m_count),
53  MakeUintegerChecker<uint32_t> ())
54  .AddAttribute ("Interval",
55  "The time to wait between packets", TimeValue (Seconds (1.0)),
56  MakeTimeAccessor (&UdpClient::m_interval),
57  MakeTimeChecker ())
58  .AddAttribute ("RemoteAddress",
59  "The destination Address of the outbound packets",
60  AddressValue (),
61  MakeAddressAccessor (&UdpClient::m_peerAddress),
62  MakeAddressChecker ())
63  .AddAttribute ("RemotePort", "The destination port of the outbound packets",
64  UintegerValue (100),
65  MakeUintegerAccessor (&UdpClient::m_peerPort),
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),
70  MakeUintegerAccessor (&UdpClient::m_size),
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_sendEvent = Simulator::Schedule (Seconds (0.0), &UdpClient::Send, this);
143 }
144 
145 void
147 {
148  NS_LOG_FUNCTION (this);
150 }
151 
152 void
154 {
155  NS_LOG_FUNCTION (this);
157  SeqTsHeader seqTs;
158  seqTs.SetSeq (m_sent);
159  Ptr<Packet> p = Create<Packet> (m_size-(8+4)); // 8+4 : the size of the seqTs header
160  p->AddHeader (seqTs);
161 
162  std::stringstream peerAddressStringStream;
164  {
165  peerAddressStringStream << Ipv4Address::ConvertFrom (m_peerAddress);
166  }
168  {
169  peerAddressStringStream << Ipv6Address::ConvertFrom (m_peerAddress);
170  }
171 
172  if ((m_socket->Send (p)) >= 0)
173  {
174  ++m_sent;
175  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
176  << peerAddressStringStream.str () << " Uid: "
177  << p->GetUid () << " Time: "
178  << (Simulator::Now ()).GetSeconds ());
179 
180  }
181  else
182  {
183  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
184  << peerAddressStringStream.str ());
185  }
186 
187  if (m_sent < m_count)
188  {
190  }
191 }
192 
193 } // Namespace ns3
static bool IsMatchingType(const Address &address)
If the Address matches the type.
an Inet address class
#define NS_LOG_FUNCTION(parameters)
Definition: log.h:345
NS_LOG_COMPONENT_DEFINE("GrantedTimeWindowMpiInterface")
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:121
uint64_t GetUid(void) const
A packet is allocated a new uid when it is created empty or with zero-filled payload.
Definition: packet.cc:393
#define NS_ASSERT(condition)
Definition: assert.h:64
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
#define NS_LOG_INFO(msg)
Definition: log.h:298
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:1395
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:824
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-client.cc:146
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:61
hold objects of type ns3::Time
Definition: nstime.h:961
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: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:44
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:153
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: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.
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:452
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:114
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:90
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:611
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:536
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.