A Discrete-Event Network Simulator
API
ns3::BulkSendApplication Class Reference

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< SocketGetSocket (void) const
 Get the socket this application is attached to. More...
 
void SetMaxBytes (uint64_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< NodeGetNode () 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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. 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)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. 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 (const Address &from, const Address &to)
 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...
 
bool m_enableSeqTsSizeHeader {false}
 Enable or disable the SeqTsSizeHeader. More...
 
Address m_local
 Local address to bind to. More...
 
uint64_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...
 
uint32_t m_seq {0}
 Sequence. More...
 
Ptr< Socketm_socket
 Associated socket. More...
 
TypeId m_tid
 The type of protocol to use. More...
 
uint64_t m_totBytes
 Total bytes sent so far. More...
 
TracedCallback< Ptr< const Packet > > m_txTrace
 Traced Callback: sent packets. More...
 
TracedCallback< Ptr< const Packet >, const Address &, const Address &, const SeqTsSizeHeader & > m_txTraceWithSeqTsSize
 Callback for tracing the packet Tx events, includes source, destination, the packet sent, and header. More...
 
Ptr< Packetm_unsentPacket
 Variable to cache unsent packet. More...
 

Additional Inherited Members

- Public Types inherited from ns3::Application
typedef void(* DelayAddressCallback) (const Time &delay, const Address &from)
 Common callback signature for packet delay and address. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. 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.

If the attribute "EnableSeqTsSizeHeader" is enabled, the application will use some bytes of the payload to store an header with a sequence number, a timestamp, and the size of the packet sent. Support for extracting statistics from this header have been added to ns3::PacketSink (enable its "EnableSeqTsSizeHeader" attribute), or users may extract the header via trace sources.

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
  • Local: The Address on which to bind the socket. If not set, it is generated automatically.
    • 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: uint64_t 0:18446744073709551615
    • Initial value: 0
    • Flags: construct write read
  • Protocol: The type of protocol to use.
  • EnableSeqTsSizeHeader: Add SeqTsSizeHeader to each packet
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • 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 -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read

TraceSources

Size of this type is 240 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ BulkSendApplication()

ns3::BulkSendApplication::BulkSendApplication ( )

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

References NS_LOG_FUNCTION.

◆ ~BulkSendApplication()

ns3::BulkSendApplication::~BulkSendApplication ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ConnectionFailed()

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

Connection Failed (called by Socket through a callback)

Parameters
socketthe connected socket

Definition at line 300 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:

◆ ConnectionSucceeded()

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

Connection Succeeded (called by Socket through a callback)

Parameters
socketthe connected socket

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

References ns3::Socket::GetPeerName(), ns3::Socket::GetSockName(), 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:

◆ DataSend()

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

Send more data as soon as some has been transmitted.

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

References ns3::Socket::GetPeerName(), ns3::Socket::GetSockName(), m_connected, NS_LOG_FUNCTION, and SendData().

Referenced by StartApplication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::BulkSendApplication::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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 118 of file bulk-send-application.cc.

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

+ Here is the call graph for this function:

◆ GetSocket()

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

Get the socket this application is attached to.

Returns
pointer to associated socket

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

References m_socket, and NS_LOG_FUNCTION.

◆ GetTypeId()

◆ SendData()

void ns3::BulkSendApplication::SendData ( const Address from,
const Address to 
)
private

◆ SetMaxBytes()

void ns3::BulkSendApplication::SetMaxBytes ( uint64_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
maxBytesthe upper bound of bytes to send

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

References m_maxBytes, and NS_LOG_FUNCTION.

◆ StartApplication()

◆ StopApplication()

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

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_connected

bool ns3::BulkSendApplication::m_connected
private

True if connected.

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

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

◆ m_enableSeqTsSizeHeader

bool ns3::BulkSendApplication::m_enableSeqTsSizeHeader {false}
private

Enable or disable the SeqTsSizeHeader.

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

Referenced by GetTypeId(), and SendData().

◆ m_local

Address ns3::BulkSendApplication::m_local
private

Local address to bind to.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_maxBytes

uint64_t ns3::BulkSendApplication::m_maxBytes
private

Limit total number of bytes sent.

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

Referenced by GetTypeId(), SendData(), and SetMaxBytes().

◆ m_peer

Address ns3::BulkSendApplication::m_peer
private

Peer address.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_sendSize

uint32_t ns3::BulkSendApplication::m_sendSize
private

Size of data to send each time.

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

Referenced by GetTypeId(), and SendData().

◆ m_seq

uint32_t ns3::BulkSendApplication::m_seq {0}
private

Sequence.

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

Referenced by SendData().

◆ m_socket

Ptr<Socket> ns3::BulkSendApplication::m_socket
private

Associated socket.

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

Referenced by DoDispose(), GetSocket(), SendData(), StartApplication(), and StopApplication().

◆ m_tid

TypeId ns3::BulkSendApplication::m_tid
private

The type of protocol to use.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_totBytes

uint64_t ns3::BulkSendApplication::m_totBytes
private

Total bytes sent so far.

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

Referenced by SendData().

◆ m_txTrace

TracedCallback<Ptr<const Packet> > ns3::BulkSendApplication::m_txTrace
private

Traced Callback: sent packets.

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

Referenced by GetTypeId(), and SendData().

◆ m_txTraceWithSeqTsSize

TracedCallback<Ptr<const Packet>, const Address &, const Address &, const SeqTsSizeHeader &> ns3::BulkSendApplication::m_txTraceWithSeqTsSize
private

Callback for tracing the packet Tx events, includes source, destination, the packet sent, and header.

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

Referenced by GetTypeId(), and SendData().

◆ m_unsentPacket

Ptr<Packet> ns3::BulkSendApplication::m_unsentPacket
private

Variable to cache unsent packet.

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

Referenced by DoDispose(), and SendData().


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