ns3::OnOffApplication Class Reference
[OnOffApplication]

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

#include <onoff-application.h>

Inheritance diagram for ns3::OnOffApplication:

Inheritance graph
[legend]
Collaboration diagram for ns3::OnOffApplication:

Collaboration graph
[legend]

List of all members.

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::OnOffApplication.

Protected Member Functions

virtual void DoDispose (void)

Private Member Functions

virtual void StartApplication (void)
 Application specific startup code.
virtual void StopApplication (void)
 Application specific shutdown code.

Private Attributes

TypeId m_tid

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.

Member Function Documentation

virtual void ns3::OnOffApplication::DoDispose ( void   )  [protected, virtual]

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.

Reimplemented from ns3::Application.

static TypeId ns3::OnOffApplication::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::OnOffApplication.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication
Attributes defined for this type:
  • 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 RandomVariable used to pick the duration of the 'On' state.
  • OffTime: A RandomVariable 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.
TraceSources defined for this type:
  • Tx: A new packet is created and is sent

Reimplemented from ns3::Application.

virtual void ns3::OnOffApplication::StartApplication ( void   )  [private, virtual]

Application specific startup code.

The StartApplication method is called at the start time specifed by Start This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

virtual void ns3::OnOffApplication::StopApplication ( void   )  [private, virtual]

Application specific shutdown code.

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

Reimplemented from ns3::Application.

Member Data Documentation

TypeId ns3::OnOffApplication::m_tid [private]

Identifies the type of this object instance.

Reimplemented from ns3::Object.

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 15:01:08 2010 for NS-3 by  doxygen 1.5.8