ns3::BulkSendApplication Class Reference

#include <introspected-doxygen.h>

Inheritance diagram for ns3::BulkSendApplication:

Public Member Functions
Ptr< Socket >	GetSocket (void) const
void	SetMaxBytes (uint32_t maxBytes)
Public Member Functions inherited from ns3::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
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
SimpleRefCount &	operator= (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	ConnectionFailed (Ptr< Socket > socket)
void	ConnectionSucceeded (Ptr< Socket > socket)
void	DataSend (Ptr< Socket >, uint32_t)
void	Ignore (Ptr< Socket > socket)
void	SendData ()
virtual void	StartApplication (void)
	Application specific startup code. More...
virtual void	StopApplication (void)
	Application specific shutdown code. More...

Private Attributes
bool	m_connected
uint32_t	m_maxBytes
Address	m_peer
uint32_t	m_sendSize
Ptr< Socket >	m_socket
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

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: 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 50 of file bulk-send-application.h.

Member Function Documentation

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 101 of file bulk-send-application.cc.

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

Ptr< Socket > ns3::BulkSendApplication::GetSocket

(

void

)

const

Returns

pointer to associated socket

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

References NS_LOG_FUNCTION.

void ns3::BulkSendApplication::SetMaxBytes

(

uint32_t

maxBytes

)

Parameters

maxBytes

the upper bound of bytes to send

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.

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

References 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 111 of file bulk-send-application.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::Socket::GetSocketType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::MakeCallback(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Socket::SetConnectCallback(), ns3::Socket::SetSendCallback(), and ns3::Socket::ShutdownRecv().

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

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

---

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

• src/applications/model/bulk-send-application.h
• src/applications/model/bulk-send-application.cc