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 ()
virtual	~OnOffApplication ()
int64_t	AssignStreams (int64_t stream)
Ptr< Socket >	GetSocket (void) const
void	SetMaxBytes (uint32_t maxBytes)
Public Member Functions inherited from ns3::Application
	Application ()
virtual	~Application ()
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 ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~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)
	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
	Object (const Object &o)
virtual void	NotifyNewAggregate (void)

Private Member Functions
void	CancelEvents ()
void	ConnectionFailed (Ptr< Socket >)
void	ConnectionSucceeded (Ptr< Socket >)
void	Construct (Ptr< Node > n, const Address &remote, std::string tid, const RandomVariable &ontime, const RandomVariable &offtime, uint32_t size)
void	Ignore (Ptr< Socket >)
void	ScheduleNextTx ()
void	ScheduleStartEvent ()
void	ScheduleStopEvent ()
void	SendPacket ()
virtual void	StartApplication (void)
void	StartSending ()
virtual void	StopApplication (void)
void	StopSending ()

Private Attributes
DataRate	m_cbrRate
bool	m_connected
Time	m_lastStartTime
uint32_t	m_maxBytes
Ptr< RandomVariableStream >	m_offTime
Ptr< RandomVariableStream >	m_onTime
Address	m_peer
uint32_t	m_pktSize
uint32_t	m_residualBits
EventId	m_sendEvent
bool	m_sending
Ptr< Socket >	m_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< Node >	m_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.

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

Constructor & Destructor Documentation

ns3::OnOffApplication::OnOffApplication ( )

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

References NS_LOG_FUNCTION_NOARGS, and ns3::Seconds().

Here is the call graph for this function:

ns3::OnOffApplication::~OnOffApplication ( )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

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

stream first stream index to use

Returns: the number of stream indices assigned by this model

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

References NS_LOG_FUNCTION.

void ns3::OnOffApplication::CancelEvents ( )

private

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

References ns3::Now(), NS_LOG_FUNCTION_NOARGS, and ns3::Time::To().

Here is the call graph for this function:

void ns3::OnOffApplication::ConnectionFailed ( Ptr< Socket > )

private

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

References NS_LOG_FUNCTION_NOARGS.

void ns3::OnOffApplication::ConnectionSucceeded ( Ptr< Socket > )

private

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

References NS_LOG_FUNCTION_NOARGS.

void ns3::OnOffApplication::Construct	(	Ptr< Node >	n,
		const Address &	remote,
		std::string	tid,
		const RandomVariable &	ontime,
		const RandomVariable &	offtime,
		uint32_t	size
	)

private

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

References NS_LOG_FUNCTION_NOARGS.

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

Returns: pointer to associated socket

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

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
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 1:4294967295
- Initial value: 512
- Flags: construct write read
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.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::ConstantRandomVariable[Constant=1.0]
- Flags: construct write read
OffTime: A RandomVariableStream used to pick the duration of the 'Off' state.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::ConstantRandomVariable[Constant=1.0]
- Flags: construct write read
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write read
Protocol: The type of protocol to use.
- Set with class: TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::UdpSocketFactory
- Flags: construct write read

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.

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

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

Here is the call graph for this function:

void ns3::OnOffApplication::Ignore ( Ptr< Socket > )

private

void ns3::OnOffApplication::ScheduleNextTx ( )

private

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

References NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, ns3::Seconds(), and SendPacket().

Here is the call graph for this function:

void ns3::OnOffApplication::ScheduleStartEvent ( )

private

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

References NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and ns3::Seconds().

Here is the call graph for this function:

void ns3::OnOffApplication::ScheduleStopEvent ( )

private

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

References NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and ns3::Seconds().

Here is the call graph for this function:

void ns3::OnOffApplication::SendPacket ( )

private

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

References ns3::Now(), NS_ASSERT, NS_LOG_FUNCTION_NOARGS, and NS_LOG_INFO.

Here is the call graph for this function:

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

Parameters

maxBytes the 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 112 of file onoff-application.cc.

References NS_LOG_FUNCTION.

void ns3::OnOffApplication::StartApplication ( void )

privatevirtual

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

References NS_LOG_FUNCTION_NOARGS.

void ns3::OnOffApplication::StartSending ( )

private

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

References ns3::Now(), and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

void ns3::OnOffApplication::StopApplication ( void )

privatevirtual

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

References NS_LOG_FUNCTION_NOARGS, and NS_LOG_WARN.

void ns3::OnOffApplication::StopSending ( )

private

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

References NS_LOG_FUNCTION_NOARGS.

Member Data Documentation

DataRate ns3::OnOffApplication::m_cbrRate

private

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

bool ns3::OnOffApplication::m_connected

private

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

Time ns3::OnOffApplication::m_lastStartTime

private

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

uint32_t ns3::OnOffApplication::m_maxBytes

private

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

Ptr<RandomVariableStream> ns3::OnOffApplication::m_offTime

private

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

Ptr<RandomVariableStream> ns3::OnOffApplication::m_onTime

private

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

Address ns3::OnOffApplication::m_peer

private

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

uint32_t ns3::OnOffApplication::m_pktSize

private

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

uint32_t ns3::OnOffApplication::m_residualBits

private

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

EventId ns3::OnOffApplication::m_sendEvent

private

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

bool ns3::OnOffApplication::m_sending

private

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

Ptr<Socket> ns3::OnOffApplication::m_socket

private

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

EventId ns3::OnOffApplication::m_startStopEvent

private

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

TypeId ns3::OnOffApplication::m_tid

private

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

uint32_t ns3::OnOffApplication::m_totBytes

private

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

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

private

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

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

src/applications/model/onoff-application.h
doc/introspected-doxygen.h
src/applications/model/onoff-application.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation