ns-3
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:

List of all members.

Public Member Functions

void SetMaxBytes (uint32_t maxBytes)
Ptr< SocketGetSocket (void) const
- Public Member Functions inherited from ns3::Application
void SetStartTime (Time start)
 Specify application start time.
void SetStopTime (Time stop)
 Specify application stop time.
Ptr< NodeGetNode () const
void SetNode (Ptr< Node > node)
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::OnOffApplication.

Protected Member Functions

virtual void DoDispose (void)
- Protected Member Functions inherited from ns3::Application
virtual void DoStart (void)
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
 Object (const Object &o)

Additional Inherited Members

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

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.


Member Function Documentation

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.

References NS_LOG_FUNCTION_NOARGS.

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

References NS_LOG_FUNCTION.

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.

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 defined for this type:

  • Tx: A new packet is created and is sent

Reimplemented from ns3::Application.

References ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

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.

References NS_LOG_FUNCTION.


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