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#include "ns3/boolean.h"
45
46namespace ns3 {
47
48NS_LOG_COMPONENT_DEFINE ("OnOffApplication");
49
50NS_OBJECT_ENSURE_REGISTERED (OnOffApplication);
51
52TypeId
54{
55 static TypeId tid = TypeId ("ns3::OnOffApplication")
57 .SetGroupName("Applications")
58 .AddConstructor<OnOffApplication> ()
59 .AddAttribute ("DataRate", "The data rate in on state.",
60 DataRateValue (DataRate ("500kb/s")),
61 MakeDataRateAccessor (&OnOffApplication::m_cbrRate),
62 MakeDataRateChecker ())
63 .AddAttribute ("PacketSize", "The size of packets sent in on state",
64 UintegerValue (512),
66 MakeUintegerChecker<uint32_t> (1))
67 .AddAttribute ("Remote", "The address of the destination",
68 AddressValue (),
69 MakeAddressAccessor (&OnOffApplication::m_peer),
70 MakeAddressChecker ())
71 .AddAttribute ("Local",
72 "The Address on which to bind the socket. If not set, it is generated automatically.",
73 AddressValue (),
74 MakeAddressAccessor (&OnOffApplication::m_local),
75 MakeAddressChecker ())
76 .AddAttribute ("OnTime", "A RandomVariableStream used to pick the duration of the 'On' state.",
77 StringValue ("ns3::ConstantRandomVariable[Constant=1.0]"),
79 MakePointerChecker <RandomVariableStream>())
80 .AddAttribute ("OffTime", "A RandomVariableStream used to pick the duration of the 'Off' state.",
81 StringValue ("ns3::ConstantRandomVariable[Constant=1.0]"),
83 MakePointerChecker <RandomVariableStream>())
84 .AddAttribute ("MaxBytes",
85 "The total number of bytes to send. Once these bytes are sent, "
86 "no packet is sent again, even in on state. The value zero means "
87 "that there is no limit.",
88 UintegerValue (0),
90 MakeUintegerChecker<uint64_t> ())
91 .AddAttribute ("Protocol", "The type of protocol to use. This should be "
92 "a subclass of ns3::SocketFactory",
95 // This should check for SocketFactory as a parent
97 .AddAttribute ("EnableSeqTsSizeHeader",
98 "Enable use of SeqTsSizeHeader for sequence number and timestamp",
99 BooleanValue (false),
102 .AddTraceSource ("Tx", "A new packet is created and is sent",
104 "ns3::Packet::TracedCallback")
105 .AddTraceSource ("TxWithAddresses", "A new packet is created and is sent",
107 "ns3::Packet::TwoAddressTracedCallback")
108 .AddTraceSource ("TxWithSeqTsSize", "A new packet is created with SeqTsSizeHeader",
110 "ns3::PacketSink::SeqTsSizeCallback")
111 ;
112 return tid;
113}
114
115
117 : m_socket (0),
118 m_connected (false),
119 m_residualBits (0),
120 m_lastStartTime (Seconds (0)),
121 m_totBytes (0),
122 m_unsentPacket (0)
123{
124 NS_LOG_FUNCTION (this);
125}
126
128{
129 NS_LOG_FUNCTION (this);
130}
131
132void
134{
135 NS_LOG_FUNCTION (this << maxBytes);
136 m_maxBytes = maxBytes;
137}
138
141{
142 NS_LOG_FUNCTION (this);
143 return m_socket;
144}
145
146int64_t
148{
149 NS_LOG_FUNCTION (this << stream);
150 m_onTime->SetStream (stream);
151 m_offTime->SetStream (stream + 1);
152 return 2;
153}
154
155void
157{
158 NS_LOG_FUNCTION (this);
159
160 CancelEvents ();
161 m_socket = 0;
162 m_unsentPacket = 0;
163 // chain up
165}
166
167// Application Methods
168void OnOffApplication::StartApplication () // Called at time specified by Start
169{
170 NS_LOG_FUNCTION (this);
171
172 // Create the socket if not already
173 if (!m_socket)
174 {
176 int ret = -1;
177
178 if (! m_local.IsInvalid())
179 {
182 "Incompatible peer and local address IP version");
183 ret = m_socket->Bind (m_local);
184 }
185 else
186 {
188 {
189 ret = m_socket->Bind6 ();
190 }
193 {
194 ret = m_socket->Bind ();
195 }
196 }
197
198 if (ret == -1)
199 {
200 NS_FATAL_ERROR ("Failed to bind socket");
201 }
202
206
210 }
212
213 // Insure no pending event
214 CancelEvents ();
215 // If we are not yet connected, there is nothing to do here
216 // The ConnectionComplete upcall will start timers at that time
217 //if (!m_connected) return;
219}
220
221void OnOffApplication::StopApplication () // Called at time specified by Stop
222{
223 NS_LOG_FUNCTION (this);
224
225 CancelEvents ();
226 if(m_socket != 0)
227 {
228 m_socket->Close ();
229 }
230 else
231 {
232 NS_LOG_WARN ("OnOffApplication found null socket to close in StopApplication");
233 }
234}
235
237{
238 NS_LOG_FUNCTION (this);
239
241 { // Cancel the pending send packet event
242 // Calculate residual bits since last packet sent
244 int64x64_t bits = delta.To (Time::S) * m_cbrRate.GetBitRate ();
245 m_residualBits += bits.GetHigh ();
246 }
250 // Canceling events may cause discontinuity in sequence number if the
251 // SeqTsSizeHeader is header, and m_unsentPacket is true
252 if (m_unsentPacket)
253 {
254 NS_LOG_DEBUG ("Discarding cached packet upon CancelEvents ()");
255 }
256 m_unsentPacket = 0;
257}
258
259// Event handlers
261{
262 NS_LOG_FUNCTION (this);
264 ScheduleNextTx (); // Schedule the send packet event
266}
267
269{
270 NS_LOG_FUNCTION (this);
271 CancelEvents ();
272
274}
275
276// Private helpers
278{
279 NS_LOG_FUNCTION (this);
280
281 if (m_maxBytes == 0 || m_totBytes < m_maxBytes)
282 {
283 NS_ABORT_MSG_IF (m_residualBits > m_pktSize * 8, "Calculation to compute next send time will overflow");
284 uint32_t bits = m_pktSize * 8 - m_residualBits;
285 NS_LOG_LOGIC ("bits = " << bits);
286 Time nextTime (Seconds (bits /
287 static_cast<double>(m_cbrRate.GetBitRate ()))); // Time till next packet
288 NS_LOG_LOGIC ("nextTime = " << nextTime.As (Time::S));
291 }
292 else
293 { // All done, cancel any pending events
295 }
296}
297
299{ // Schedules the event to start sending data (switch to the "On" state)
300 NS_LOG_FUNCTION (this);
301
302 Time offInterval = Seconds (m_offTime->GetValue ());
303 NS_LOG_LOGIC ("start at " << offInterval.As (Time::S));
305}
306
308{ // Schedules the event to stop sending data (switch to "Off" state)
309 NS_LOG_FUNCTION (this);
310
311 Time onInterval = Seconds (m_onTime->GetValue ());
312 NS_LOG_LOGIC ("stop at " << onInterval.As (Time::S));
314}
315
316
318{
319 NS_LOG_FUNCTION (this);
320
322
323 Ptr<Packet> packet;
324 if (m_unsentPacket)
325 {
326 packet = m_unsentPacket;
327 }
329 {
330 Address from, to;
331 m_socket->GetSockName (from);
332 m_socket->GetPeerName (to);
333 SeqTsSizeHeader header;
334 header.SetSeq (m_seq++);
335 header.SetSize (m_pktSize);
337 packet = Create<Packet> (m_pktSize - header.GetSerializedSize ());
338 // Trace before adding header, for consistency with PacketSink
339 m_txTraceWithSeqTsSize (packet, from, to, header);
340 packet->AddHeader (header);
341 }
342 else
343 {
344 packet = Create<Packet> (m_pktSize);
345 }
346
347 int actual = m_socket->Send (packet);
348 if ((unsigned) actual == m_pktSize)
349 {
350 m_txTrace (packet);
352 m_unsentPacket = 0;
353 Address localAddress;
354 m_socket->GetSockName (localAddress);
356 {
357 NS_LOG_INFO ("At time " << Simulator::Now ().As (Time::S)
358 << " on-off application sent "
359 << packet->GetSize () << " bytes to "
362 << " total Tx " << m_totBytes << " bytes");
364 }
366 {
367 NS_LOG_INFO ("At time " << Simulator::Now ().As (Time::S)
368 << " on-off application sent "
369 << packet->GetSize () << " bytes to "
372 << " total Tx " << m_totBytes << " bytes");
374 }
375 }
376 else
377 {
378 NS_LOG_DEBUG ("Unable to send packet; actual " << actual << " size " << m_pktSize << "; caching for later attempt");
379 m_unsentPacket = packet;
380 }
381 m_residualBits = 0;
384}
385
386
388{
389 NS_LOG_FUNCTION (this << socket);
390 m_connected = true;
391}
392
394{
395 NS_LOG_FUNCTION (this << socket);
396 NS_FATAL_ERROR ("Can't connect");
397}
398
399
400} // Namespace ns3
a polymophic address class
Definition: address.h:91
bool IsInvalid(void) const
Definition: address.cc:68
AttributeValue implementation for Address.
The base class for all ns3 applications.
Definition: application.h:61
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
Ptr< Node > GetNode() const
Definition: application.cc:104
AttributeValue implementation for Boolean.
Definition: boolean.h:37
Class for representing data rates.
Definition: data-rate.h:89
uint64_t GetBitRate() const
Get the underlying bitrate.
Definition: data-rate.cc:287
AttributeValue implementation for DataRate.
bool IsRunning(void) const
This method is syntactic sugar for !IsExpired().
Definition: event-id.cc:71
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:65
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
static bool IsMatchingType(const Address &addr)
If the address match.
Ipv6Address GetIpv6(void) const
Get the IPv6 address.
uint16_t GetPort(void) const
Get the port.
uint16_t GetPort(void) const
Ipv4Address GetIpv4(void) const
static bool IsMatchingType(const Address &address)
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
Generate traffic to a single destination according to an OnOff pattern.
uint32_t m_residualBits
Number of generated, but not sent, bits.
virtual void StartApplication(void)
Application specific startup code.
void ConnectionSucceeded(Ptr< Socket > socket)
Handle a Connection Succeed event.
EventId m_sendEvent
Event id of pending "send packet" event.
void ScheduleStartEvent()
Schedule the next On period start.
bool m_connected
True if connected.
uint32_t m_pktSize
Size of packets.
Ptr< Socket > m_socket
Associated socket.
TracedCallback< Ptr< const Packet > > m_txTrace
Traced Callback: transmitted packets.
virtual void DoDispose(void)
Destructor implementation.
void SetMaxBytes(uint64_t maxBytes)
Set the total number of bytes to send.
Ptr< RandomVariableStream > m_offTime
rng for Off Time
Ptr< Packet > m_unsentPacket
Unsent packet cached for future attempt.
TracedCallback< Ptr< const Packet >, const Address &, const Address &, const SeqTsSizeHeader & > m_txTraceWithSeqTsSize
Callback for tracing the packet Tx events, includes source, destination, the packet sent,...
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
EventId m_startStopEvent
Event id for next start or stop event.
void ScheduleNextTx()
Schedule the next packet transmission.
DataRate m_cbrRateFailSafe
Rate that data is generated (check copy)
void ConnectionFailed(Ptr< Socket > socket)
Handle a Connection Failed event.
void ScheduleStopEvent()
Schedule the next Off period start.
static TypeId GetTypeId(void)
Get the type ID.
uint64_t m_maxBytes
Limit total number of bytes sent.
virtual void StopApplication(void)
Application specific shutdown code.
Ptr< Socket > GetSocket(void) const
Return a pointer to associated socket.
Time m_lastStartTime
Time last packet sent.
uint64_t m_totBytes
Total bytes sent so far.
void StopSending()
Start an Off period.
void StartSending()
Start an On period.
Address m_local
Local address to bind to.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Ptr< RandomVariableStream > m_onTime
rng for On Time
bool m_enableSeqTsSizeHeader
Enable or disable the use of SeqTsSizeHeader.
TypeId m_tid
Type of the socket used.
uint32_t m_seq
Sequence.
DataRate m_cbrRate
Rate that data is generated.
Address m_peer
Peer address.
void CancelEvents()
Cancel all pending events.
void SendPacket()
Send a packet.
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:256
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:856
static bool IsMatchingType(const Address &address)
virtual double GetValue(void)=0
Get the next random value as a double drawn from the distribution.
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
void SetSeq(uint32_t seq)
Header with a sequence, a timestamp, and a "size" attribute.
virtual uint32_t GetSerializedSize(void) const override
void SetSize(uint64_t size)
Set the size information that the header will carry.
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
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:556
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
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
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
virtual int ShutdownRecv(void)=0
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
virtual int GetPeerName(Address &address) const =0
Get the peer address of a connected socket.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual int GetSockName(Address &address) const =0
Get socket address.
virtual int Close(void)=0
Close a 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
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Hold variables of type string.
Definition: string.h:41
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
int64x64_t To(enum Unit unit) const
Get the Time value expressed in a particular unit.
Definition: nstime.h:533
@ S
second
Definition: nstime.h:114
TimeWithUnit As(const enum Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition: time.cc:418
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
AttributeValue implementation for TypeId.
Definition: type-id.h:595
static TypeId GetTypeId(void)
Get the type ID.
Hold an unsigned integer type.
Definition: uinteger.h:44
High precision numerical type, implementing Q64.64 fixed precision.
int64_t GetHigh(void) const
Get the integer portion.
#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
Ptr< const AttributeChecker > MakeBooleanChecker(void)
Definition: boolean.cc:121
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Definition: boolean.h:85
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Definition: pointer.h:227
Ptr< const AttributeAccessor > MakeTypeIdAccessor(T1 a1)
Definition: type-id.h:595
Ptr< const AttributeChecker > MakeTypeIdChecker(void)
Definition: type-id.cc:1226
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:45
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
Definition: abort.h:108
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
Definition: abort.h:77
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:273
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:289
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:265
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648