A Discrete-Event Network Simulator
API
ns3::OnOffApplication Class Reference

Generate traffic to a single destination according to an OnOff pattern. More...

#include "onoff-application.h"

+ Inheritance diagram for ns3::OnOffApplication:
+ Collaboration diagram for ns3::OnOffApplication:

Public Member Functions

 OnOffApplication ()
 
 ~OnOffApplication () override
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
Ptr< SocketGetSocket () const
 Return a pointer to associated socket. More...
 
void SetMaxBytes (uint64_t maxBytes)
 Set the total number of bytes to send. More...
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
 ~Application () override
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
void DoDispose () override
 Destructor implementation. More...
 
void DoInitialize () override
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void CancelEvents ()
 Cancel all pending events. More...
 
void ConnectionFailed (Ptr< Socket > socket)
 Handle a Connection Failed event. More...
 
void ConnectionSucceeded (Ptr< Socket > socket)
 Handle a Connection Succeed event. More...
 
void ScheduleNextTx ()
 Schedule the next packet transmission. More...
 
void ScheduleStartEvent ()
 Schedule the next On period start. More...
 
void ScheduleStopEvent ()
 Schedule the next Off period start. More...
 
void SendPacket ()
 Send a packet. More...
 
void StartApplication () override
 Application specific startup code. More...
 
void StartSending ()
 Start an On period. More...
 
void StopApplication () override
 Application specific shutdown code. More...
 
void StopSending ()
 Start an Off period. More...
 

Private Attributes

DataRate m_cbrRate
 Rate that data is generated. More...
 
DataRate m_cbrRateFailSafe
 Rate that data is generated (check copy) More...
 
bool m_connected
 True if connected. More...
 
bool m_enableSeqTsSizeHeader {false}
 Enable or disable the use of SeqTsSizeHeader. More...
 
Time m_lastStartTime
 Time last packet sent. More...
 
Address m_local
 Local address to bind to. More...
 
uint64_t m_maxBytes
 Limit total number of bytes sent. More...
 
Ptr< RandomVariableStreamm_offTime
 rng for Off Time More...
 
Ptr< RandomVariableStreamm_onTime
 rng for On Time More...
 
Address m_peer
 Peer address. More...
 
uint32_t m_pktSize
 Size of packets. More...
 
uint32_t m_residualBits
 Number of generated, but not sent, bits. More...
 
EventId m_sendEvent
 Event id of pending "send packet" event. More...
 
uint32_t m_seq {0}
 Sequence. More...
 
Ptr< Socketm_socket
 Associated socket. More...
 
EventId m_startStopEvent
 Event id for next start or stop event. More...
 
TypeId m_tid
 Type of the socket used. More...
 
uint64_t m_totBytes
 Total bytes sent so far. More...
 
TracedCallback< Ptr< const Packet > > m_txTrace
 Traced Callback: transmitted packets. More...
 
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
 Callbacks for tracing the packet Tx events, includes source and destination addresses. More...
 
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, and header. More...
 
Ptr< Packetm_unsentPacket
 Unsent packet cached for future attempt. More...
 

Additional Inherited Members

- Public Types inherited from ns3::Application
typedef void(* DelayAddressCallback) (const Time &delay, const Address &from)
 Common callback signature for packet delay and address. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

Detailed Description

Generate traffic to a single destination according to an OnOff pattern.

This traffic generator follows an On/Off pattern: after Application::StartApplication is called, "On" and "Off" states alternate. The duration of each of these states is determined with the onTime and the offTime random variables. During the "Off" state, no traffic is generated. During the "On" state, cbr traffic is generated. This cbr traffic is characterized by the specified "data rate" and "packet size".

Note: When an application is started, the first packet transmission occurs after a delay equal to (packet size/bit rate). Note also, when an application transitions into an off state in between packet transmissions, the remaining time until when the next transmission would have occurred is cached and is used when the application starts up again. Example: packet size = 1000 bits, bit rate = 500 bits/sec. If the application is started at time 3 seconds, the first packet transmission will be scheduled for time 5 seconds (3 + 1000/500) and subsequent transmissions at 2 second intervals. If the above application were instead stopped at time 4 seconds, and restarted at time 5.5 seconds, then the first packet would be sent at time 6.5 seconds, because when it was stopped at 4 seconds, there was only 1 second remaining until the originally scheduled transmission, and this time remaining information is cached and used to schedule the next transmission upon restarting.

If the underlying socket type supports broadcast, this application will automatically enable the SetAllowBroadcast(true) socket option.

If the attribute "EnableSeqTsSizeHeader" is enabled, the application will use some bytes of the payload to store an header with a sequence number, a timestamp, and the size of the packet sent. Support for extracting statistics from this header have been added to ns3::PacketSink (enable its "EnableSeqTsSizeHeader" attribute), or users may extract the header via trace sources. Note that the continuity of the sequence number may be disrupted across On/Off cycles.

Definition at line 96 of file onoff-application.h.

Constructor & Destructor Documentation

◆ OnOffApplication()

ns3::OnOffApplication::OnOffApplication ( )

Definition at line 126 of file onoff-application.cc.

References NS_LOG_FUNCTION.

◆ ~OnOffApplication()

ns3::OnOffApplication::~OnOffApplication ( )
override

Definition at line 137 of file onoff-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::OnOffApplication::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 157 of file onoff-application.cc.

References m_offTime, m_onTime, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ CancelEvents()

void ns3::OnOffApplication::CancelEvents ( )
private

◆ ConnectionFailed()

void ns3::OnOffApplication::ConnectionFailed ( Ptr< Socket socket)
private

Handle a Connection Failed event.

Parameters
socketthe not connected socket

Definition at line 420 of file onoff-application.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by StartApplication().

+ Here is the caller graph for this function:

◆ ConnectionSucceeded()

void ns3::OnOffApplication::ConnectionSucceeded ( Ptr< Socket socket)
private

Handle a Connection Succeed event.

Parameters
socketthe connected socket

Definition at line 411 of file onoff-application.cc.

References m_connected, NS_LOG_FUNCTION, and ScheduleStartEvent().

Referenced by StartApplication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::OnOffApplication::DoDispose ( void  )
overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 166 of file onoff-application.cc.

References CancelEvents(), ns3::Application::DoDispose(), m_socket, m_unsentPacket, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetSocket()

Ptr< Socket > ns3::OnOffApplication::GetSocket ( ) const

Return a pointer to associated socket.

Returns
pointer to associated socket

Definition at line 150 of file onoff-application.cc.

References m_socket, and NS_LOG_FUNCTION.

◆ GetTypeId()

◆ ScheduleNextTx()

void ns3::OnOffApplication::ScheduleNextTx ( )
private

Schedule the next packet transmission.

Definition at line 299 of file onoff-application.cc.

References ns3::Time::As(), ns3::DataRate::GetBitRate(), m_cbrRate, m_maxBytes, m_pktSize, m_residualBits, m_sendEvent, m_totBytes, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Time::S, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), and StopApplication().

Referenced by SendPacket(), and StartSending().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ScheduleStartEvent()

void ns3::OnOffApplication::ScheduleStartEvent ( )
private

Schedule the next On period start.

Definition at line 321 of file onoff-application.cc.

References ns3::Time::As(), ns3::RandomVariableStream::GetValue(), m_offTime, m_startStopEvent, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Time::S, ns3::Simulator::Schedule(), ns3::Seconds(), and StartSending().

Referenced by ConnectionSucceeded(), StartApplication(), and StopSending().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ScheduleStopEvent()

void ns3::OnOffApplication::ScheduleStopEvent ( )
private

Schedule the next Off period start.

Definition at line 331 of file onoff-application.cc.

References ns3::Time::As(), ns3::RandomVariableStream::GetValue(), m_onTime, m_startStopEvent, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Time::S, ns3::Simulator::Schedule(), ns3::Seconds(), and StopSending().

Referenced by StartSending().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SendPacket()

◆ SetMaxBytes()

void ns3::OnOffApplication::SetMaxBytes ( uint64_t  maxBytes)

Set the total number of bytes to send.

Once these bytes are sent, no packet is sent again, even in on state. The value zero means that there is no limit.

Parameters
maxBytesthe total number of bytes to send

Definition at line 143 of file onoff-application.cc.

References m_maxBytes, and NS_LOG_FUNCTION.

◆ StartApplication()

void ns3::OnOffApplication::StartApplication ( void  )
overrideprivatevirtual

◆ StartSending()

void ns3::OnOffApplication::StartSending ( )
private

Start an On period.

Definition at line 280 of file onoff-application.cc.

References m_lastStartTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, ScheduleNextTx(), and ScheduleStopEvent().

Referenced by ScheduleStartEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StopApplication()

void ns3::OnOffApplication::StopApplication ( void  )
overrideprivatevirtual

Application specific shutdown code.

The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 239 of file onoff-application.cc.

References CancelEvents(), ns3::Socket::Close(), m_socket, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by ScheduleNextTx().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StopSending()

void ns3::OnOffApplication::StopSending ( )
private

Start an Off period.

Definition at line 289 of file onoff-application.cc.

References CancelEvents(), NS_LOG_FUNCTION, and ScheduleStartEvent().

Referenced by ScheduleStopEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cbrRate

DataRate ns3::OnOffApplication::m_cbrRate
private

Rate that data is generated.

Definition at line 168 of file onoff-application.h.

Referenced by CancelEvents(), GetTypeId(), ScheduleNextTx(), and StartApplication().

◆ m_cbrRateFailSafe

DataRate ns3::OnOffApplication::m_cbrRateFailSafe
private

Rate that data is generated (check copy)

Definition at line 169 of file onoff-application.h.

Referenced by CancelEvents(), and StartApplication().

◆ m_connected

bool ns3::OnOffApplication::m_connected
private

True if connected.

Definition at line 165 of file onoff-application.h.

Referenced by ConnectionSucceeded(), and StartApplication().

◆ m_enableSeqTsSizeHeader

bool ns3::OnOffApplication::m_enableSeqTsSizeHeader {false}
private

Enable or disable the use of SeqTsSizeHeader.

Definition at line 180 of file onoff-application.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_lastStartTime

Time ns3::OnOffApplication::m_lastStartTime
private

Time last packet sent.

Definition at line 172 of file onoff-application.h.

Referenced by CancelEvents(), SendPacket(), and StartSending().

◆ m_local

Address ns3::OnOffApplication::m_local
private

Local address to bind to.

Definition at line 164 of file onoff-application.h.

Referenced by GetTypeId(), and StartApplication().

◆ m_maxBytes

uint64_t ns3::OnOffApplication::m_maxBytes
private

Limit total number of bytes sent.

Definition at line 173 of file onoff-application.h.

Referenced by GetTypeId(), ScheduleNextTx(), and SetMaxBytes().

◆ m_offTime

Ptr<RandomVariableStream> ns3::OnOffApplication::m_offTime
private

rng for Off Time

Definition at line 167 of file onoff-application.h.

Referenced by AssignStreams(), GetTypeId(), and ScheduleStartEvent().

◆ m_onTime

Ptr<RandomVariableStream> ns3::OnOffApplication::m_onTime
private

rng for On Time

Definition at line 166 of file onoff-application.h.

Referenced by AssignStreams(), GetTypeId(), and ScheduleStopEvent().

◆ m_peer

Address ns3::OnOffApplication::m_peer
private

Peer address.

Definition at line 163 of file onoff-application.h.

Referenced by GetTypeId(), SendPacket(), and StartApplication().

◆ m_pktSize

uint32_t ns3::OnOffApplication::m_pktSize
private

Size of packets.

Definition at line 170 of file onoff-application.h.

Referenced by GetTypeId(), ScheduleNextTx(), and SendPacket().

◆ m_residualBits

uint32_t ns3::OnOffApplication::m_residualBits
private

Number of generated, but not sent, bits.

Definition at line 171 of file onoff-application.h.

Referenced by CancelEvents(), ScheduleNextTx(), and SendPacket().

◆ m_sendEvent

EventId ns3::OnOffApplication::m_sendEvent
private

Event id of pending "send packet" event.

Definition at line 176 of file onoff-application.h.

Referenced by CancelEvents(), ScheduleNextTx(), and SendPacket().

◆ m_seq

uint32_t ns3::OnOffApplication::m_seq {0}
private

Sequence.

Definition at line 178 of file onoff-application.h.

Referenced by SendPacket().

◆ m_socket

Ptr<Socket> ns3::OnOffApplication::m_socket
private

Associated socket.

Definition at line 162 of file onoff-application.h.

Referenced by DoDispose(), GetSocket(), SendPacket(), StartApplication(), and StopApplication().

◆ m_startStopEvent

EventId ns3::OnOffApplication::m_startStopEvent
private

Event id for next start or stop event.

Definition at line 175 of file onoff-application.h.

Referenced by CancelEvents(), ScheduleStartEvent(), and ScheduleStopEvent().

◆ m_tid

TypeId ns3::OnOffApplication::m_tid
private

Type of the socket used.

Definition at line 177 of file onoff-application.h.

Referenced by GetTypeId(), and StartApplication().

◆ m_totBytes

uint64_t ns3::OnOffApplication::m_totBytes
private

Total bytes sent so far.

Definition at line 174 of file onoff-application.h.

Referenced by ScheduleNextTx(), and SendPacket().

◆ m_txTrace

TracedCallback<Ptr<const Packet> > ns3::OnOffApplication::m_txTrace
private

Traced Callback: transmitted packets.

Definition at line 183 of file onoff-application.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_txTraceWithAddresses

TracedCallback<Ptr<const Packet>, const Address&, const Address&> ns3::OnOffApplication::m_txTraceWithAddresses
private

Callbacks for tracing the packet Tx events, includes source and destination addresses.

Definition at line 186 of file onoff-application.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_txTraceWithSeqTsSize

TracedCallback<Ptr<const Packet>, const Address&, const Address&, const SeqTsSizeHeader&> ns3::OnOffApplication::m_txTraceWithSeqTsSize
private

Callback for tracing the packet Tx events, includes source, destination, the packet sent, and header.

Definition at line 191 of file onoff-application.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_unsentPacket

Ptr<Packet> ns3::OnOffApplication::m_unsentPacket
private

Unsent packet cached for future attempt.

Definition at line 179 of file onoff-application.h.

Referenced by CancelEvents(), DoDispose(), and SendPacket().


The documentation for this class was generated from the following files: