Send as much traffic as possible, trying to fill the bandwidth. More...

#include <bulk-send-application.h>

Inheritance diagram for ns3::BulkSendApplication:

Collaboration diagram for ns3::BulkSendApplication:

Public Member Functions
	BulkSendApplication ()

virtual	~BulkSendApplication ()

Ptr< Socket >	GetSocket (void) const
	Get the socket this application is attached to. More...

void	SetMaxBytes (uint32_t maxBytes)
	Set the upper bound for the total number of bytes to send. More...

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. More...

void	SetStopTime (Time stop)
	Specify application stop time. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Protected Member Functions inherited from ns3::Application
virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Private Member Functions
void	ConnectionFailed (Ptr< Socket > socket)
	Connection Failed (called by Socket through a callback) More...

void	ConnectionSucceeded (Ptr< Socket > socket)
	Connection Succeeded (called by Socket through a callback) More...

void	DataSend (Ptr< Socket >, uint32_t)
	Send more data as soon as some has been transmitted. More...

void	SendData ()
	Send data until the L4 transmission buffer is full. More...

virtual void	StartApplication (void)
	Application specific startup code. More...

virtual void	StopApplication (void)
	Application specific shutdown code. More...

Private Attributes
bool	m_connected
	True if connected. More...

uint32_t	m_maxBytes
	Limit total number of bytes sent. More...

Address	m_peer
	Peer address. More...

uint32_t	m_sendSize
	Size of data to send each time. More...

Ptr< Socket >	m_socket
	Associated socket. More...

TypeId	m_tid
	The type of protocol to use. More...

uint32_t	m_totBytes
	Total bytes sent so far. More...

TracedCallback< Ptr< const Packet > >	m_txTrace
	Traced Callback: sent packets. More...

Additional Inherited Members
Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node

EventId	m_startEvent
	The simulation time that the appliacation will end. More...

Time	m_startTime
	The node that this application is installed on. More...

EventId	m_stopEvent
	The event that will fire at m_startTime to start the application. More...

Time	m_stopTime
	The simulation time that the appliacation will start. More...

Detailed Description

Send as much traffic as possible, trying to fill the bandwidth.

This traffic generator simply sends data as fast as possible up to MaxBytes or until the application is stopped (if MaxBytes is zero). Once the lower layer send buffer is filled, it waits until space is free to send more data, essentially keeping a constant flow of data. Only SOCK_STREAM and SOCK_SEQPACKET sockets are supported. For example, TCP sockets can be used, but UDP sockets can not be used.

Config Paths

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

/NodeList/[i]/ApplicationList/[i]/$ns3::BulkSendApplication

Attributes

SendSize: The amount of data to send each time.
- 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
MaxBytes: The total number of bytes to send. Once these bytes are sent, no data is sent again. 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::TcpSocketFactory
- Flags: construct write read

Attributes defined in parent class ns3::Application

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

TraceSources

Tx: A new packet is created and is sent

Definition at line 68 of file bulk-send-application.h.

Constructor & Destructor Documentation

ns3::BulkSendApplication::BulkSendApplication ( )

Definition at line 74 of file bulk-send-application.cc.

References NS_LOG_FUNCTION.

ns3::BulkSendApplication::~BulkSendApplication ( )

virtual

Definition at line 82 of file bulk-send-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::BulkSendApplication::ConnectionFailed ( Ptr< Socket > socket )

private

Connection Failed (called by Socket through a callback)

Parameters

socket the connected socket

Definition at line 215 of file bulk-send-application.cc.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by StartApplication().

Here is the caller graph for this function:

void ns3::BulkSendApplication::ConnectionSucceeded ( Ptr< Socket > socket )

private

Connection Succeeded (called by Socket through a callback)

Parameters

socket the connected socket

Definition at line 207 of file bulk-send-application.cc.

References m_connected, NS_LOG_FUNCTION, NS_LOG_LOGIC, and SendData().

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BulkSendApplication::DataSend	(	Ptr< Socket >	,
		uint32_t
	)

private

Send more data as soon as some has been transmitted.

Definition at line 221 of file bulk-send-application.cc.

References m_connected, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SendData().

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BulkSendApplication::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 102 of file bulk-send-application.cc.

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

Here is the call graph for this function:

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

Get the socket this application is attached to.

Returns: pointer to associated socket

Definition at line 95 of file bulk-send-application.cc.

References m_socket, and NS_LOG_FUNCTION.

TypeId ns3::BulkSendApplication::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 42 of file bulk-send-application.cc.

References ns3::TcpSocketFactory::GetTypeId(), m_maxBytes, m_peer, m_sendSize, m_tid, m_txTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::BulkSendApplication::SendData ( void )

private

Send data until the L4 transmission buffer is full.

Definition at line 171 of file bulk-send-application.cc.

References ns3::Socket::Close(), m_connected, m_maxBytes, m_sendSize, m_socket, m_totBytes, m_txTrace, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Socket::Send().

Referenced by ConnectionSucceeded(), DataSend(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the upper bound for the total number of bytes to send.

Once this bound is reached, no more application bytes are sent. If the application is stopped during the simulation and restarted, the total number of bytes sent is not reset; however, the maxBytes bound is still effective and the application will continue sending up to maxBytes. The value zero for maxBytes means that there is no upper bound; i.e. data is sent until the application or simulation is stopped.

Parameters

maxBytes the upper bound of bytes to send

Definition at line 88 of file bulk-send-application.cc.

References m_maxBytes, and NS_LOG_FUNCTION.

void ns3::BulkSendApplication::StartApplication ( void )

privatevirtual

Application specific startup code.

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

Reimplemented from ns3::Application.

Definition at line 112 of file bulk-send-application.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ConnectionFailed(), ConnectionSucceeded(), ns3::Socket::CreateSocket(), DataSend(), ns3::Application::GetNode(), ns3::Socket::GetSocketType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_connected, m_peer, m_socket, m_tid, ns3::MakeCallback(), ns3::Socket::NS3_SOCK_SEQPACKET, ns3::Socket::NS3_SOCK_STREAM, NS_FATAL_ERROR, NS_LOG_FUNCTION, SendData(), ns3::Socket::SetConnectCallback(), ns3::Socket::SetSendCallback(), and ns3::Socket::ShutdownRecv().