A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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:

Public Member Functions

int64_t AssignStreams (int64_t stream)
 
Ptr< SocketGetSocket (void) const
 
void SetMaxBytes (uint32_t maxBytes)
 
- Public Member Functions inherited from ns3::Application
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
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Member Functions

virtual void DoDispose (void)
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Private Member Functions

void CancelEvents ()
 
void ConnectionFailed (Ptr< Socket > socket)
 
void ConnectionSucceeded (Ptr< Socket > socket)
 
void Construct (Ptr< Node > n, const Address &remote, std::string tid, const RandomVariable &ontime, const RandomVariable &offtime, uint32_t size)
 
void ScheduleNextTx ()
 
void ScheduleStartEvent ()
 
void ScheduleStopEvent ()
 
void SendPacket ()
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
void StartSending ()
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 
void StopSending ()
 

Private Attributes

DataRate m_cbrRate
 
bool m_connected
 
Time m_lastStartTime
 
uint32_t m_maxBytes
 
Ptr< RandomVariableStreamm_offTime
 
Ptr< RandomVariableStreamm_onTime
 
Address m_peer
 
uint32_t m_pktSize
 
uint32_t m_residualBits
 
EventId m_sendEvent
 
bool m_sending
 
Ptr< Socketm_socket
 
EventId m_startStopEvent
 
TypeId m_tid
 
uint32_t m_totBytes
 
TracedCallback< Ptr< const
Packet > > 
m_txTrace
 

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 
EventId m_startEvent
 
Time m_startTime
 
EventId m_stopEvent
 
Time m_stopTime
 

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.

Config Paths

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

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

Attributes

  • DataRate: The data rate in on state.
    • Set with class: DataRateValue
    • Underlying type: DataRate
    • Initial value: 500000bps
    • Flags: construct write read
  • PacketSize: The size of packets sent in on state
  • Remote: The address of the destination
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • OnTime: A RandomVariableStream used to pick the duration of the 'On' state.
  • OffTime: A RandomVariableStream used to pick the duration of the 'Off' state.
  • MaxBytes: 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.
  • Protocol: The type of protocol to use.

Attributes defined in parent class ns3::Application

  • StartTime: Time at which the application will start
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read

TraceSources

  • Tx: A new packet is created and is sent

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

Member Function Documentation

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

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

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

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

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

void ns3::OnOffApplication::DoDispose ( void  )
protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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::Application.

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

References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.

Ptr< Socket > ns3::OnOffApplication::GetSocket ( void  ) const
Returns
pointer to associated socket

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

References NS_LOG_FUNCTION.

void ns3::OnOffApplication::SetMaxBytes ( uint32_t  maxBytes)
Parameters
maxBytesthe total number of bytes to send

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.

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

References NS_LOG_FUNCTION.

void ns3::OnOffApplication::StartApplication ( void  )
privatevirtual
void ns3::OnOffApplication::StopApplication ( void  )
privatevirtual

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

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


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