A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
onoff-application.cc
Go to the documentation of this file.
1//
2// Copyright (c) 2006 Georgia Tech Research Corporation
3//
4// SPDX-License-Identifier: GPL-2.0-only
5//
6// Author: George F. Riley<riley@ece.gatech.edu>
7//
8
9// ns3 - On/Off Data Source Application class
10// George F. Riley, Georgia Tech, Spring 2007
11// Adapted from ApplicationOnOff in GTNetS.
12
13#include "onoff-application.h"
14
15#include "ns3/boolean.h"
16#include "ns3/data-rate.h"
17#include "ns3/inet-socket-address.h"
18#include "ns3/inet6-socket-address.h"
19#include "ns3/log.h"
20#include "ns3/node.h"
21#include "ns3/nstime.h"
22#include "ns3/packet-socket-address.h"
23#include "ns3/packet.h"
24#include "ns3/pointer.h"
25#include "ns3/random-variable-stream.h"
26#include "ns3/simulator.h"
27#include "ns3/socket-factory.h"
28#include "ns3/socket.h"
29#include "ns3/string.h"
30#include "ns3/trace-source-accessor.h"
31#include "ns3/udp-socket-factory.h"
32#include "ns3/uinteger.h"
33
34namespace ns3
35{
36
37NS_LOG_COMPONENT_DEFINE("OnOffApplication");
38
39NS_OBJECT_ENSURE_REGISTERED(OnOffApplication);
40
41TypeId
43{
44 static TypeId tid =
45 TypeId("ns3::OnOffApplication")
47 .SetGroupName("Applications")
48 .AddConstructor<OnOffApplication>()
49 .AddAttribute("DataRate",
50 "The data rate in on state.",
51 DataRateValue(DataRate("500kb/s")),
54 .AddAttribute("PacketSize",
55 "The size of packets sent in on state",
56 UintegerValue(512),
59 .AddAttribute("OnTime",
60 "A RandomVariableStream used to pick the duration of the 'On' state.",
61 StringValue("ns3::ConstantRandomVariable[Constant=1.0]"),
64 .AddAttribute("OffTime",
65 "A RandomVariableStream used to pick the duration of the 'Off' state.",
66 StringValue("ns3::ConstantRandomVariable[Constant=1.0]"),
69 .AddAttribute("MaxBytes",
70 "The total number of bytes to send. Once these bytes are sent, "
71 "no packet is sent again, even in on state. The value zero means "
72 "that there is no limit.",
76 .AddAttribute("Protocol",
77 "The type of protocol to use. This should be "
78 "a subclass of ns3::SocketFactory",
81 // This should check for SocketFactory as a parent
83 .AddAttribute("EnableSeqTsSizeHeader",
84 "Enable use of SeqTsSizeHeader for sequence number and timestamp",
85 BooleanValue(false),
88 .AddTraceSource("Tx",
89 "A new packet is created and is sent",
91 "ns3::Packet::TracedCallback")
92 .AddTraceSource("TxWithAddresses",
93 "A new packet is created and is sent",
95 "ns3::Packet::TwoAddressTracedCallback")
96 .AddTraceSource("TxWithSeqTsSize",
97 "A new packet is created with SeqTsSizeHeader",
99 "ns3::PacketSink::SeqTsSizeCallback");
100 return tid;
101}
102
104 : m_socket(nullptr),
105 m_connected(false),
106 m_residualBits(0),
107 m_lastStartTime(Seconds(0)),
108 m_totBytes(0),
109 m_unsentPacket(nullptr)
110{
111 NS_LOG_FUNCTION(this);
112}
113
118
119void
121{
122 NS_LOG_FUNCTION(this << maxBytes);
123 m_maxBytes = maxBytes;
124}
125
128{
129 NS_LOG_FUNCTION(this);
130 return m_socket;
131}
132
133int64_t
135{
136 NS_LOG_FUNCTION(this << stream);
137 auto currentStream = stream;
138 m_onTime->SetStream(currentStream++);
139 m_offTime->SetStream(currentStream++);
140 currentStream += Application::AssignStreams(currentStream);
141 return (currentStream - stream);
142}
143
144void
146{
147 NS_LOG_FUNCTION(this);
148
149 CancelEvents();
150 m_socket = nullptr;
151 m_unsentPacket = nullptr;
152 // chain up
154}
155
156// Application Methods
157void
158OnOffApplication::StartApplication() // Called at time specified by Start
159{
160 NS_LOG_FUNCTION(this);
161
162 // Create the socket if not already
163 if (!m_socket)
164 {
166 int ret = -1;
167
168 NS_ABORT_MSG_IF(m_peer.IsInvalid(), "'Remote' attribute not properly set");
169
170 if (!m_local.IsInvalid())
171 {
176 "Incompatible peer and local address IP version");
177 ret = m_socket->Bind(m_local);
178 }
179 else
180 {
182 {
183 ret = m_socket->Bind6();
184 }
187 {
188 ret = m_socket->Bind();
189 }
190 }
191
192 if (ret == -1)
193 {
194 NS_FATAL_ERROR("Failed to bind socket");
195 }
196
199
201 {
202 m_socket->SetIpTos(m_tos); // Affects only IPv4 sockets.
203 }
207 }
209
210 // Ensure no pending event
211 CancelEvents();
212
213 // If we are not yet connected, there is nothing to do here,
214 // the ConnectionComplete upcall will start timers at that time.
215 // If we are already connected, CancelEvents did remove the events,
216 // so we have to start them again.
217 if (m_connected)
218 {
220 }
221}
222
223void
224OnOffApplication::StopApplication() // Called at time specified by Stop
225{
226 NS_LOG_FUNCTION(this);
227
228 CancelEvents();
229 if (m_socket)
230 {
231 m_socket->Close();
232 }
233 else
234 {
235 NS_LOG_WARN("OnOffApplication found null socket to close in StopApplication");
236 }
237}
238
239void
241{
242 NS_LOG_FUNCTION(this);
243
245 { // Cancel the pending send packet event
246 // Calculate residual bits since last packet sent
248 int64x64_t bits = delta.To(Time::S) * m_cbrRate.GetBitRate();
249 m_residualBits += bits.GetHigh();
250 }
254 // Canceling events may cause discontinuity in sequence number if the
255 // SeqTsSizeHeader is header, and m_unsentPacket is true
256 if (m_unsentPacket)
257 {
258 NS_LOG_DEBUG("Discarding cached packet upon CancelEvents ()");
259 }
260 m_unsentPacket = nullptr;
261}
262
263// Event handlers
264void
266{
267 NS_LOG_FUNCTION(this);
269 ScheduleNextTx(); // Schedule the send packet event
271}
272
273void
281
282// Private helpers
283void
285{
286 NS_LOG_FUNCTION(this);
287
288 if (m_maxBytes == 0 || m_totBytes < m_maxBytes)
289 {
291 "Calculation to compute next send time will overflow");
292 uint32_t bits = m_pktSize * 8 - m_residualBits;
293 NS_LOG_LOGIC("bits = " << bits);
294 Time nextTime(
295 Seconds(bits / static_cast<double>(m_cbrRate.GetBitRate()))); // Time till next packet
296 NS_LOG_LOGIC("nextTime = " << nextTime.As(Time::S));
298 }
299 else
300 { // All done, cancel any pending events
302 }
303}
304
305void
307{ // Schedules the event to start sending data (switch to the "On" state)
308 NS_LOG_FUNCTION(this);
309
310 Time offInterval = Seconds(m_offTime->GetValue());
311 NS_LOG_LOGIC("start at " << offInterval.As(Time::S));
313}
314
315void
317{ // Schedules the event to stop sending data (switch to "Off" state)
318 NS_LOG_FUNCTION(this);
319
320 Time onInterval = Seconds(m_onTime->GetValue());
321 NS_LOG_LOGIC("stop at " << onInterval.As(Time::S));
323}
324
325void
327{
328 NS_LOG_FUNCTION(this);
329
331
332 Ptr<Packet> packet;
333 if (m_unsentPacket)
334 {
335 packet = m_unsentPacket;
336 }
338 {
339 Address from;
340 Address to;
341 m_socket->GetSockName(from);
343 SeqTsSizeHeader header;
344 header.SetSeq(m_seq++);
345 header.SetSize(m_pktSize);
347 packet = Create<Packet>(m_pktSize - header.GetSerializedSize());
348 // Trace before adding header, for consistency with PacketSink
349 m_txTraceWithSeqTsSize(packet, from, to, header);
350 packet->AddHeader(header);
351 }
352 else
353 {
354 packet = Create<Packet>(m_pktSize);
355 }
356
357 int actual = m_socket->Send(packet);
358 if ((unsigned)actual == m_pktSize)
359 {
360 m_txTrace(packet);
362 m_unsentPacket = nullptr;
363 Address localAddress;
364 m_socket->GetSockName(localAddress);
366 {
367 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " on-off application sent "
368 << packet->GetSize() << " bytes to "
371 << " total Tx " << m_totBytes << " bytes");
373 }
375 {
376 NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " on-off application sent "
377 << packet->GetSize() << " bytes to "
380 << " total Tx " << m_totBytes << " bytes");
382 }
383 }
384 else
385 {
386 NS_LOG_DEBUG("Unable to send packet; actual " << actual << " size " << m_pktSize
387 << "; caching for later attempt");
388 m_unsentPacket = packet;
389 }
390 m_residualBits = 0;
393}
394
395void
397{
398 NS_LOG_FUNCTION(this << socket);
399
401 m_connected = true;
402}
403
404void
406{
407 NS_LOG_FUNCTION(this << socket);
408 NS_FATAL_ERROR("Can't connect");
409}
410
411} // Namespace ns3
a polymophic address class
Definition address.h:90
bool IsInvalid() const
Definition address.cc:60
void DoDispose() override
Destructor implementation.
virtual int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this Application object.
Ptr< Node > GetNode() const
AttributeValue implementation for Boolean.
Definition boolean.h:26
Class for representing data rates.
Definition data-rate.h:78
uint64_t GetBitRate() const
Get the underlying bitrate.
Definition data-rate.cc:234
AttributeValue implementation for DataRate.
Definition data-rate.h:285
bool IsPending() const
This method is syntactic sugar for !IsExpired().
Definition event-id.cc:65
bool IsExpired() const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition event-id.cc:58
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
uint16_t GetPort() const
Get the port.
static bool IsMatchingType(const Address &addr)
If the address match.
Ipv6Address GetIpv6() const
Get the IPv6 address.
static bool IsMatchingType(const Address &address)
Ipv4Address GetIpv4() const
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.
static TypeId GetTypeId()
Get the type ID.
uint32_t m_residualBits
Number of generated, but not sent, bits.
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 > GetSocket() const
Return a pointer to associated socket.
Ptr< Socket > m_socket
Associated socket.
TracedCallback< Ptr< const Packet > > m_txTrace
Traced Callback: transmitted packets.
void SetMaxBytes(uint64_t maxBytes)
Set the total number of bytes to send.
Ptr< RandomVariableStream > m_offTime
rng for Off Time
void StartApplication() override
Application specific startup code.
Ptr< Packet > m_unsentPacket
Unsent packet cached for future attempt.
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this Application object.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
void DoDispose() override
Destructor implementation.
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.
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,...
uint64_t m_maxBytes
Limit total number of bytes sent.
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.
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.
void StopApplication() override
Application specific shutdown code.
void CancelEvents()
Cancel all pending events.
void SendPacket()
Send a packet.
static bool IsMatchingType(const Address &address)
Smart pointer class similar to boost::intrusive_ptr.
virtual double GetValue()=0
Get the next random value 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.
uint32_t GetSerializedSize() const override
void SetSize(uint64_t size)
Set the size information that the header will carry.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition simulator.h:560
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:274
static Time Now()
Return the current simulation virtual time.
Definition simulator.cc:197
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:76
void SetIpTos(uint8_t ipTos)
Manually set IP Type of Service field.
Definition socket.cc:423
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
virtual int ShutdownRecv()=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.
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:61
virtual int Close()=0
Close a socket.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Base class for source applications.
Address m_local
Local address to bind to.
uint8_t m_tos
The packets Type of Service.
Address m_peer
Peer address.
Hold variables of type string.
Definition string.h:45
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition time.cc:404
@ S
second
Definition nstime.h:105
a unique identifier for an interface.
Definition type-id.h:48
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition type-id.cc:1001
AttributeValue implementation for TypeId.
Definition type-id.h:617
static TypeId GetTypeId()
Get the type ID.
Hold an unsigned integer type.
Definition uinteger.h:34
High precision numerical type, implementing Q64.64 fixed precision.
int64_t GetHigh() 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:55
Ptr< const AttributeChecker > MakeBooleanChecker()
Definition boolean.cc:113
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method.
Definition boolean.h:70
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:285
Ptr< const AttributeChecker > MakeDataRateChecker()
Definition data-rate.cc:20
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:248
Ptr< AttributeChecker > MakePointerChecker()
Create a PointerChecker for a type.
Definition pointer.h:269
Ptr< const AttributeChecker > MakeTypeIdChecker()
Definition type-id.cc:1320
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:617
Ptr< const AttributeChecker > MakeUintegerChecker()
Definition uinteger.h:85
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:35
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
Definition abort.h:97
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
Definition abort.h:65
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition log.h:257
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition log.h:271
#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:250
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition log.h:264
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition object-base.h:35
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Definition ptr.h:436
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition nstime.h:1308
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, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition callback.h:684