A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::OnOffApplication Class Reference
Applications » OnOffApplication

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) override
 Assign a fixed random variable stream number to the random variables used by this Application object.
void SetMaxBytes (uint64_t maxBytes)
 Set the total number of bytes to send.
Public Member Functions inherited from ns3::SourceApplication
 SourceApplication (bool allowPacketSocket=true)
 Constructor.
 ~SourceApplication () override
Address GetRemote () const
 get the remote address
Ptr< Socket > GetSocket () const
 Get the socket this application is attached to.
virtual void SetRemote (const Address &addr)
 set the remote address
Public Member Functions inherited from ns3::Application
 Application ()
 ~Application () override
Ptr< Node > GetNode () const
void SetNode (Ptr< Node > node)
void SetStartTime (Time start)
 Specify application start time.
void SetStopTime (Time stop)
 Specify application stop time.
Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 ~Object () override
 Destructor.
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
void Dispose ()
 Dispose of this Object.
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
template<typename T>
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
template<typename T>
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
bool IsInitialized () const
 Check if the object has been initialized.
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
uint32_t GetReferenceCount () const
 Get the reference count of the object.
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
void Ref () const
 Increment the reference count.
void Unref () const
 Decrement the reference count.
Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions

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

Private Member Functions

void CancelEvents () override
 Cancel all pending events.
void DoConnectionSucceeded (Ptr< Socket > socket) override
 Application specific code for child subclasses upon a Connection Succeed event.
void DoStartApplication () override
 Application specific startup code for child subclasses.
void ScheduleNextTx ()
 Schedule the next packet transmission.
void ScheduleStartEvent ()
 Schedule the next On period start.
void ScheduleStopEvent ()
 Schedule the next Off period start.
void SendPacket ()
 Send a packet.
void StartSending ()
 Start an On period.
void StopSending ()
 Start an Off period.

Private Attributes

DataRate m_cbrRate
 Rate that data is generated.
DataRate m_cbrRateFailSafe
 Rate that data is generated (check copy).
bool m_enableSeqTsSizeHeader {false}
 Enable or disable the use of SeqTsSizeHeader.
Time m_lastStartTime
 Time last packet sent.
uint64_t m_maxBytes
 Limit total number of bytes sent.
Ptr< RandomVariableStream > m_offTime
 rng for Off Time
Ptr< RandomVariableStream > m_onTime
 rng for On Time
uint32_t m_pktSize
 Size of packets.
uint32_t m_residualBits {0}
 Number of generated, but not sent, bits.
EventId m_sendEvent
 Event id of pending "send packet" event.
uint32_t m_seq {0}
 Sequence.
EventId m_startStopEvent
 Event id for next start or stop event.
TracedValue< bool > m_state
 State of application (0-OFF, 1-ON).
uint64_t m_totBytes {0}
 Total bytes sent so far.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
 Callbacks for tracing the packet Tx events, includes source and destination addresses.
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.
Ptr< Packet > m_unsentPacket
 Unsent packet cached for future attempt.

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.
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source.
Protected Types inherited from ns3::SourceApplication
typedef void(* ConnectionEventCallback) (Ptr< Socket > socket, const Address &local, const Address &remote)
 TracedCallback signature for connection success/failure event.
Protected Member Functions inherited from ns3::SourceApplication
bool CloseSocket ()
 Close the socket.
void DoDispose () override
 Destructor implementation.
Protected Member Functions inherited from ns3::Application
void DoInitialize () override
 Initialize() implementation.
Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
Protected Attributes inherited from ns3::SourceApplication
bool m_connected {false}
 flag whether socket is connected
TracedCallback< Ptr< Socket >, const Address &, const Address & > m_connectionFailure
 Traced Callback: connection failure event.
TracedCallback< Ptr< Socket >, const Address &, const Address & > m_connectionSuccess
 Traced Callback: connection success event.
Address m_local
 Local address to bind to.
Address m_peer
 Peer address.
TypeId m_protocolTid
 Protocol TypeId value.
Ptr< Socket > m_socket
 Socket.
uint8_t m_tos
 The packets Type of Service.
TracedCallback< Ptr< const Packet > > m_txTrace
 Traced Callback: transmitted packets.
Protected Attributes inherited from ns3::Application
Ptr< Node > m_node
 The node that this application is installed on.
EventId m_startEvent
 The event that will fire at m_startTime to start the application.
Time m_startTime
 The simulation time that the application will start.
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application.
Time m_stopTime
 The simulation time that the application will end.
Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.

Config Paths

ns3::OnOffApplication is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/ApplicationList/[i]/$ns3::SourceApplication/$ns3::OnOffApplication"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication"

Attributes

Attributes defined in parent class ns3::SourceApplication

  • Local: The Address on which to bind the socket. If not set, it is generated automatically when needed by the application.
    • Set with class: ns3::AddressValue
    • Underlying type: Address
    • Initial value:
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • Remote: The address of the destination, made of the remote IP address and the destination port
    • Set with class: ns3::AddressValue
    • Underlying type: Address
    • Initial value:
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • Tos: The Type of Service used to send IPv4 packets. All 8 bits of the TOS byte are set (including ECN bits).
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::Application

  • StartTime: Time at which the application will start
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • StopTime: Time at which the application will stop
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: constructwriteread
    • Support level: SUPPORTED

TraceSources

TraceSources defined in parent class ns3::SourceApplication

Group: Applications
Size of this type is 480 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ OnOffApplication()

ns3::OnOffApplication::OnOffApplication ( )

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

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~OnOffApplication()

ns3::OnOffApplication::~OnOffApplication ( )
override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

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

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

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

Reimplemented from ns3::Application.

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

References ns3::Application::AssignStreams(), m_offTime, m_onTime, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ CancelEvents()

void ns3::OnOffApplication::CancelEvents ( )
overrideprivatevirtual

Cancel all pending events.

Implements ns3::SourceApplication.

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

References ns3::Simulator::Cancel(), ns3::int64x64_t::GetHigh(), m_cbrRate, m_cbrRateFailSafe, m_lastStartTime, m_residualBits, m_sendEvent, m_startStopEvent, m_unsentPacket, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::S.

Referenced by ScheduleNextTx(), and StopSending().

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

◆ DoConnectionSucceeded()

void ns3::OnOffApplication::DoConnectionSucceeded ( Ptr< Socket > socket)
overrideprivatevirtual

Application specific code for child subclasses upon a Connection Succeed event.

Parameters
socketthe connected socket

Reimplemented from ns3::SourceApplication.

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

References NS_LOG_FUNCTION, and ScheduleStartEvent().

Here is the call graph for this function:

◆ DoStartApplication()

void ns3::OnOffApplication::DoStartApplication ( )
overrideprivatevirtual

Application specific startup code for child subclasses.

Reimplemented from ns3::SourceApplication.

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

References m_cbrRate, m_cbrRateFailSafe, ns3::SourceApplication::m_connected, ns3::SourceApplication::m_socket, NS_LOG_FUNCTION, and ScheduleStartEvent().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::OnOffApplication::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

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

References OnOffApplication(), ns3::SourceApplication::SourceApplication(), ns3::UdpSocketFactory::GetTypeId(), m_cbrRate, m_enableSeqTsSizeHeader, m_maxBytes, m_offTime, m_onTime, m_pktSize, ns3::SourceApplication::m_protocolTid, m_state, m_txTraceWithAddresses, m_txTraceWithSeqTsSize, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDataRateAccessor(), ns3::MakeDataRateChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeTypeIdAccessor(), ns3::MakeTypeIdChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ ScheduleNextTx()

void ns3::OnOffApplication::ScheduleNextTx ( )
private

Schedule the next packet transmission.

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

References ns3::Time::As(), CancelEvents(), ns3::SourceApplication::CloseSocket(), 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(), and SendPacket().

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 222 of file onoff-application.cc.

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

Referenced by DoConnectionSucceeded(), DoStartApplication(), 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 232 of file onoff-application.cc.

References ns3::Time::As(), 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()

void ns3::OnOffApplication::SendPacket ( )
private

Send a packet.

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

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Create(), ns3::SeqTsSizeHeader::GetSerializedSize(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_enableSeqTsSizeHeader, m_lastStartTime, ns3::SourceApplication::m_peer, m_pktSize, m_residualBits, m_sendEvent, m_seq, ns3::SourceApplication::m_socket, m_totBytes, ns3::SourceApplication::m_txTrace, m_txTraceWithAddresses, m_txTraceWithSeqTsSize, m_unsentPacket, ns3::Simulator::Now(), NS_ABORT_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::S, ScheduleNextTx(), ns3::SeqTsHeader::SetSeq(), and ns3::SeqTsSizeHeader::SetSize().

Referenced by ScheduleNextTx().

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

◆ 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 114 of file onoff-application.cc.

References m_maxBytes, and NS_LOG_FUNCTION.

◆ StartSending()

void ns3::OnOffApplication::StartSending ( )
private

Start an On period.

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

References m_lastStartTime, m_state, 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:

◆ StopSending()

void ns3::OnOffApplication::StopSending ( )
private

Start an Off period.

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

References CancelEvents(), m_state, 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 140 of file onoff-application.h.

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

◆ m_cbrRateFailSafe

DataRate ns3::OnOffApplication::m_cbrRateFailSafe
private

Rate that data is generated (check copy).

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

Referenced by CancelEvents(), and DoStartApplication().

◆ m_enableSeqTsSizeHeader

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

Enable or disable the use of SeqTsSizeHeader.

Definition at line 151 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 144 of file onoff-application.h.

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

◆ m_maxBytes

uint64_t ns3::OnOffApplication::m_maxBytes
private

Limit total number of bytes sent.

Definition at line 145 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 139 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 138 of file onoff-application.h.

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

◆ m_pktSize

uint32_t ns3::OnOffApplication::m_pktSize
private

Size of packets.

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

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

◆ m_residualBits

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

Number of generated, but not sent, bits.

Definition at line 143 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 148 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 149 of file onoff-application.h.

Referenced by SendPacket().

◆ m_startStopEvent

EventId ns3::OnOffApplication::m_startStopEvent
private

Event id for next start or stop event.

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

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

◆ m_state

TracedValue<bool> ns3::OnOffApplication::m_state
private

State of application (0-OFF, 1-ON).

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

Referenced by GetTypeId(), StartSending(), and StopSending().

◆ m_totBytes

uint64_t ns3::OnOffApplication::m_totBytes {0}
private

Total bytes sent so far.

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

Referenced by ScheduleNextTx(), 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 154 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 159 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 150 of file onoff-application.h.

Referenced by CancelEvents(), and SendPacket().

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