A Discrete-Event Network Simulator
API
onoff-application.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 //
3 // Copyright (c) 2006 Georgia Tech Research Corporation
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: George F. Riley<riley@ece.gatech.edu>
19 //
20 
21 // ns3 - On/Off Data Source Application class
22 // George F. Riley, Georgia Tech, Spring 2007
23 // Adapted from ApplicationOnOff in GTNetS.
24 
25 #include "ns3/log.h"
26 #include "ns3/address.h"
27 #include "ns3/inet-socket-address.h"
28 #include "ns3/inet6-socket-address.h"
29 #include "ns3/packet-socket-address.h"
30 #include "ns3/node.h"
31 #include "ns3/nstime.h"
32 #include "ns3/data-rate.h"
33 #include "ns3/random-variable-stream.h"
34 #include "ns3/socket.h"
35 #include "ns3/simulator.h"
36 #include "ns3/socket-factory.h"
37 #include "ns3/packet.h"
38 #include "ns3/uinteger.h"
39 #include "ns3/trace-source-accessor.h"
40 #include "onoff-application.h"
41 #include "ns3/udp-socket-factory.h"
42 #include "ns3/string.h"
43 #include "ns3/pointer.h"
44 
45 namespace ns3 {
46 
47 NS_LOG_COMPONENT_DEFINE ("OnOffApplication");
48 
49 NS_OBJECT_ENSURE_REGISTERED (OnOffApplication);
50 
51 TypeId
53 {
54  static TypeId tid = TypeId ("ns3::OnOffApplication")
56  .SetGroupName("Applications")
57  .AddConstructor<OnOffApplication> ()
58  .AddAttribute ("DataRate", "The data rate in on state.",
59  DataRateValue (DataRate ("500kb/s")),
62  .AddAttribute ("PacketSize", "The size of packets sent in on state",
63  UintegerValue (512),
65  MakeUintegerChecker<uint32_t> (1))
66  .AddAttribute ("Remote", "The address of the destination",
67  AddressValue (),
70  .AddAttribute ("OnTime", "A RandomVariableStream used to pick the duration of the 'On' state.",
71  StringValue ("ns3::ConstantRandomVariable[Constant=1.0]"),
73  MakePointerChecker <RandomVariableStream>())
74  .AddAttribute ("OffTime", "A RandomVariableStream used to pick the duration of the 'Off' state.",
75  StringValue ("ns3::ConstantRandomVariable[Constant=1.0]"),
77  MakePointerChecker <RandomVariableStream>())
78  .AddAttribute ("MaxBytes",
79  "The total number of bytes to send. Once these bytes are sent, "
80  "no packet is sent again, even in on state. The value zero means "
81  "that there is no limit.",
82  UintegerValue (0),
84  MakeUintegerChecker<uint64_t> ())
85  .AddAttribute ("Protocol", "The type of protocol to use. This should be "
86  "a subclass of ns3::SocketFactory",
89  // This should check for SocketFactory as a parent
91  .AddTraceSource ("Tx", "A new packet is created and is sent",
93  "ns3::Packet::TracedCallback")
94  .AddTraceSource ("TxWithAddresses", "A new packet is created and is sent",
96  "ns3::Packet::TwoAddressTracedCallback")
97  ;
98  return tid;
99 }
100 
101 
103  : m_socket (0),
104  m_connected (false),
105  m_residualBits (0),
106  m_lastStartTime (Seconds (0)),
107  m_totBytes (0)
108 {
109  NS_LOG_FUNCTION (this);
110 }
111 
113 {
114  NS_LOG_FUNCTION (this);
115 }
116 
117 void
118 OnOffApplication::SetMaxBytes (uint64_t maxBytes)
119 {
120  NS_LOG_FUNCTION (this << maxBytes);
121  m_maxBytes = maxBytes;
122 }
123 
126 {
127  NS_LOG_FUNCTION (this);
128  return m_socket;
129 }
130 
131 int64_t
133 {
134  NS_LOG_FUNCTION (this << stream);
135  m_onTime->SetStream (stream);
136  m_offTime->SetStream (stream + 1);
137  return 2;
138 }
139 
140 void
142 {
143  NS_LOG_FUNCTION (this);
144 
145  m_socket = 0;
146  // chain up
148 }
149 
150 // Application Methods
151 void OnOffApplication::StartApplication () // Called at time specified by Start
152 {
153  NS_LOG_FUNCTION (this);
154 
155  // Create the socket if not already
156  if (!m_socket)
157  {
160  {
161  if (m_socket->Bind6 () == -1)
162  {
163  NS_FATAL_ERROR ("Failed to bind socket");
164  }
165  }
168  {
169  if (m_socket->Bind () == -1)
170  {
171  NS_FATAL_ERROR ("Failed to bind socket");
172  }
173  }
175  m_socket->SetAllowBroadcast (true);
177 
181  }
183 
184  // Insure no pending event
185  CancelEvents ();
186  // If we are not yet connected, there is nothing to do here
187  // The ConnectionComplete upcall will start timers at that time
188  //if (!m_connected) return;
190 }
191 
192 void OnOffApplication::StopApplication () // Called at time specified by Stop
193 {
194  NS_LOG_FUNCTION (this);
195 
196  CancelEvents ();
197  if(m_socket != 0)
198  {
199  m_socket->Close ();
200  }
201  else
202  {
203  NS_LOG_WARN ("OnOffApplication found null socket to close in StopApplication");
204  }
205 }
206 
208 {
209  NS_LOG_FUNCTION (this);
210 
212  { // Cancel the pending send packet event
213  // Calculate residual bits since last packet sent
214  Time delta (Simulator::Now () - m_lastStartTime);
215  int64x64_t bits = delta.To (Time::S) * m_cbrRate.GetBitRate ();
216  m_residualBits += bits.GetHigh ();
217  }
221 }
222 
223 // Event handlers
225 {
226  NS_LOG_FUNCTION (this);
228  ScheduleNextTx (); // Schedule the send packet event
230 }
231 
233 {
234  NS_LOG_FUNCTION (this);
235  CancelEvents ();
236 
238 }
239 
240 // Private helpers
242 {
243  NS_LOG_FUNCTION (this);
244 
245  if (m_maxBytes == 0 || m_totBytes < m_maxBytes)
246  {
247  uint32_t bits = m_pktSize * 8 - m_residualBits;
248  NS_LOG_LOGIC ("bits = " << bits);
249  Time nextTime (Seconds (bits /
250  static_cast<double>(m_cbrRate.GetBitRate ()))); // Time till next packet
251  NS_LOG_LOGIC ("nextTime = " << nextTime);
252  m_sendEvent = Simulator::Schedule (nextTime,
254  }
255  else
256  { // All done, cancel any pending events
257  StopApplication ();
258  }
259 }
260 
262 { // Schedules the event to start sending data (switch to the "On" state)
263  NS_LOG_FUNCTION (this);
264 
265  Time offInterval = Seconds (m_offTime->GetValue ());
266  NS_LOG_LOGIC ("start at " << offInterval);
268 }
269 
271 { // Schedules the event to stop sending data (switch to "Off" state)
272  NS_LOG_FUNCTION (this);
273 
274  Time onInterval = Seconds (m_onTime->GetValue ());
275  NS_LOG_LOGIC ("stop at " << onInterval);
277 }
278 
279 
281 {
282  NS_LOG_FUNCTION (this);
283 
285  Ptr<Packet> packet = Create<Packet> (m_pktSize);
286  m_txTrace (packet);
287  m_socket->Send (packet);
289  Address localAddress;
290  m_socket->GetSockName (localAddress);
292  {
293  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
294  << "s on-off application sent "
295  << packet->GetSize () << " bytes to "
297  << " port " << InetSocketAddress::ConvertFrom (m_peer).GetPort ()
298  << " total Tx " << m_totBytes << " bytes");
300  }
302  {
303  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
304  << "s on-off application sent "
305  << packet->GetSize () << " bytes to "
308  << " total Tx " << m_totBytes << " bytes");
310  }
312  m_residualBits = 0;
313  ScheduleNextTx ();
314 }
315 
316 
318 {
319  NS_LOG_FUNCTION (this << socket);
320  m_connected = true;
321 }
322 
324 {
325  NS_LOG_FUNCTION (this << socket);
326 }
327 
328 
329 } // Namespace ns3
static TypeId GetTypeId(void)
Get the type ID.
void StopSending()
Start an Off period.
Ipv6Address GetIpv6(void) const
Get the IPv6 address.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Ipv4Address GetIpv4(void) const
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
virtual void StartApplication(void)
Application specific startup code.
EventId m_sendEvent
Event id of pending "send packet" event.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
uint32_t m_pktSize
Size of packets.
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
Hold variables of type string.
Definition: string.h:41
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
High precision numerical type, implementing Q64.64 fixed precision.
Definition: int64x64-128.h:45
void ScheduleStartEvent()
Schedule the next On period start.
void CancelEvents()
Cancel all pending events.
#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
static bool IsMatchingType(const Address &address)
Generate traffic to a single destination according to an OnOff pattern.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
virtual int GetSockName(Address &address) const =0
Get socket address.
virtual int ShutdownRecv(void)=0
void ScheduleStopEvent()
Schedule the next Off period start.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
#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:346
bool IsRunning(void) const
This method is syntactic sugar for !IsExpired().
Definition: event-id.cc:65
virtual double GetValue(void)=0
Get the next random value as a double drawn from the distribution.
a polymophic address class
Definition: address.h:90
int64x64_t To(enum Unit unit) const
Get the Time value expressed in a particular unit.
Definition: nstime.h:509
Ptr< const AttributeChecker > MakeDataRateChecker(void)
Definition: data-rate.cc:30
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
DataRate m_cbrRateFailSafe
Rate that data is generated (check copy)
Class for representing data rates.
Definition: data-rate.h:88
virtual void DoDispose(void)
Destructor implementation.
EventId m_startStopEvent
Event id for next start or stop event.
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
void SendPacket()
Send a packet.
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: pointer.h:220
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1381
TypeId m_tid
Type of the socket used.
The base class for all ns3 applications.
Definition: application.h:60
Address m_peer
Peer address.
DataRate m_cbrRate
Rate that data is generated.
Hold an unsigned integer type.
Definition: uinteger.h:44
Ptr< RandomVariableStream > m_onTime
rng for On Time
Ptr< Node > GetNode() const
Definition: application.cc:104
AttributeValue implementation for TypeId.
Definition: type-id.h:608
Ptr< Socket > GetSocket(void) const
Return a pointer to associated socket.
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
uint64_t m_totBytes
Total bytes sent so far.
Ptr< Socket > m_socket
Associated socket.
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
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Ptr< const AttributeAccessor > MakeDataRateAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: data-rate.h:242
Ptr< RandomVariableStream > m_offTime
rng for Off Time
void SetMaxBytes(uint64_t maxBytes)
Set the total number of bytes to send.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
TracedCallback< Ptr< const Packet > > m_txTrace
Traced Callback: transmitted packets.
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.
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
void ScheduleNextTx()
Schedule the next packet transmission.
void StartSending()
Start an On period.
uint64_t GetBitRate() const
Get the underlying bitrate.
Definition: data-rate.cc:249
Ptr< const AttributeChecker > MakeAddressChecker(void)
Definition: address.cc:172
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:249
NS_LOG_LOGIC("Net device "<< nd<< " is not bridged")
void ConnectionSucceeded(Ptr< Socket > socket)
Handle a Connection Succeed event.
Time m_lastStartTime
Time last packet sent.
Ptr< const AttributeAccessor > MakeTypeIdAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: type-id.h:608
AttributeValue implementation for Address.
Definition: address.h:278
static TypeId GetTypeId(void)
Get the type ID.
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:262
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1007
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
static bool IsMatchingType(const Address &addr)
If the address match.
uint16_t GetPort(void) const
Get the port.
int64_t GetHigh(void) const
Get the integer portion.
Definition: int64x64-128.h:219
void ConnectionFailed(Ptr< Socket > socket)
Handle a Connection Failed event.
uint16_t GetPort(void) const
second
Definition: nstime.h:114
void SetConnectCallback(Callback< void, Ptr< Socket > > connectionSucceeded, Callback< void, Ptr< Socket > > connectionFailed)
Specify callbacks to allow the caller to determine if the connection succeeds of fails.
Definition: socket.cc:84
bool m_connected
True if connected.
virtual void StopApplication(void)
Application specific shutdown code.
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual int Close(void)=0
Close a socket.
Ptr< const AttributeChecker > MakeTypeIdChecker(void)
Definition: type-id.cc:1225
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
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
uint32_t m_residualBits
Number of generated, but not sent, bits.
uint64_t m_maxBytes
Limit total number of bytes sent.
static bool IsMatchingType(const Address &address)