Send as much traffic as possible, trying to fill the bandwidth. More...
#include "bulk-send-application.h"
Public Member Functions | |
BulkSendApplication () | |
~BulkSendApplication () override | |
Ptr< Socket > | GetSocket () const |
Get the socket this application is attached to. | |
void | SetMaxBytes (uint64_t maxBytes) |
Set the upper bound for the total number of bytes to send. | |
Public Member Functions inherited from ns3::Application | |
Application () | |
~Application () override | |
virtual int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this Application object. | |
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 () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Application | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Application | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
void | ConnectionFailed (Ptr< Socket > socket) |
Connection Failed (called by Socket through a callback) | |
void | ConnectionSucceeded (Ptr< Socket > socket) |
Connection Succeeded (called by Socket through a callback) | |
void | DataSend (Ptr< Socket > socket, uint32_t unused) |
Send more data as soon as some has been transmitted. | |
void | PacketRetransmitted (Ptr< const Packet > p, const TcpHeader &header, const Address &localAddr, const Address &peerAddr, Ptr< const TcpSocketBase > socket) |
Packet retransmitted (called by TcpSocketBase sockets via callback) | |
void | SendData (const Address &from, const Address &to) |
Send data until the L4 transmission buffer is full. | |
void | StartApplication () override |
Application specific startup code. | |
void | StopApplication () override |
Application specific shutdown code. | |
Private Attributes | |
bool | m_connected |
True if connected. | |
bool | m_enableSeqTsSizeHeader {false} |
Enable or disable the SeqTsSizeHeader. | |
Address | m_local |
Local address to bind to. | |
uint64_t | m_maxBytes |
Limit total number of bytes sent. | |
Address | m_peer |
Peer address. | |
TracedCallback< Ptr< const Packet >, const TcpHeader &, const Address &, const Address &, Ptr< const TcpSocketBase > > | m_retransmissionTrace |
Traced Callback: retransmitted packets. | |
uint32_t | m_sendSize |
Size of data to send each time. | |
uint32_t | m_seq {0} |
Sequence. | |
Ptr< Socket > | m_socket |
Associated socket. | |
TypeId | m_tid |
The type of protocol to use. | |
uint8_t | m_tos |
The packets Type of Service. | |
uint64_t | m_totBytes |
Total bytes sent so far. | |
TracedCallback< Ptr< const Packet > > | m_txTrace |
Traced Callback: sent packets. | |
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. | |
Ptr< Packet > | m_unsentPacket |
Variable to cache unsent packet. | |
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. | |
typedef void(* | StateTransitionCallback) (const std::string &oldState, const std::string &newState) |
Common signature used by callbacks to application's state transition trace source. | |
Protected Attributes inherited from ns3::Application | |
Ptr< Node > | m_node |
The node that this application is installed on. | |
EventId | m_startEvent |
The event that will fire at m_startTime to start the application. | |
Time | m_startTime |
The simulation time that the application will start. | |
EventId | m_stopEvent |
The event that will fire at m_stopTime to end the application. | |
Time | m_stopTime |
The simulation time that the application will end. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
Definition at line 67 of file bulk-send-application.h.
ns3::BulkSendApplication::BulkSendApplication | ( | ) |
Definition at line 96 of file bulk-send-application.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 105 of file bulk-send-application.cc.
References NS_LOG_FUNCTION.
Connection Failed (called by Socket through a callback)
socket | the connected socket |
Definition at line 326 of file bulk-send-application.cc.
References NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by StartApplication().
Connection Succeeded (called by Socket through a callback)
socket | the connected socket |
Definition at line 313 of file bulk-send-application.cc.
References m_connected, NS_LOG_FUNCTION, NS_LOG_LOGIC, and SendData().
Referenced by StartApplication().
Send more data as soon as some has been transmitted.
Used in socket's SetSendCallback - params are forced by it.
socket | socket to use |
unused | actually unused |
Definition at line 333 of file bulk-send-application.cc.
References m_connected, NS_LOG_FUNCTION, and SendData().
Referenced by StartApplication().
|
overrideprotectedvirtual |
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 125 of file bulk-send-application.cc.
References ns3::Application::DoDispose(), m_socket, m_unsentPacket, and NS_LOG_FUNCTION.
Get the socket this application is attached to.
Definition at line 118 of file bulk-send-application.cc.
References m_socket, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 33 of file bulk-send-application.cc.
References ns3::TcpSocketFactory::GetTypeId(), m_enableSeqTsSizeHeader, m_local, m_maxBytes, m_peer, m_retransmissionTrace, m_sendSize, m_tid, m_tos, m_txTrace, m_txTraceWithSeqTsSize, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeTypeIdAccessor(), ns3::MakeTypeIdChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().
|
private |
Packet retransmitted (called by TcpSocketBase sockets via callback)
p | the retransmitted packet |
header | the TCP header |
localAddr | the local address |
peerAddr | the peer address |
socket | the socket that retransmitted the packet |
Definition at line 348 of file bulk-send-application.cc.
References m_retransmissionTrace, and NS_LOG_FUNCTION.
Referenced by StartApplication().
Send data until the L4 transmission buffer is full.
from | From address |
to | To address |
Definition at line 228 of file bulk-send-application.cc.
References ns3::Socket::Close(), ns3::Create(), ns3::SeqTsSizeHeader::GetSerializedSize(), m_connected, m_enableSeqTsSizeHeader, m_maxBytes, m_sendSize, m_seq, m_socket, m_totBytes, m_txTrace, m_txTraceWithSeqTsSize, m_unsentPacket, ns3::Simulator::Now(), NS_ABORT_IF, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Socket::Send(), ns3::SeqTsHeader::SetSeq(), and ns3::SeqTsSizeHeader::SetSize().
Referenced by ConnectionSucceeded(), DataSend(), and StartApplication().
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.
maxBytes | the upper bound of bytes to send |
Definition at line 111 of file bulk-send-application.cc.
References m_maxBytes, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
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 137 of file bulk-send-application.cc.
References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ConnectionFailed(), ConnectionSucceeded(), ns3::Socket::CreateSocket(), DataSend(), ns3::DynamicCast(), ns3::Application::GetNode(), ns3::Socket::GetSocketType(), ns3::Socket::GetSockName(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_connected, m_local, m_peer, m_socket, m_tid, m_tos, ns3::MakeCallback(), ns3::Socket::NS3_SOCK_SEQPACKET, ns3::Socket::NS3_SOCK_STREAM, NS_ABORT_MSG_IF, NS_FATAL_ERROR, NS_LOG_FUNCTION, PacketRetransmitted(), SendData(), ns3::Socket::SetConnectCallback(), ns3::Socket::SetIpTos(), ns3::Socket::SetSendCallback(), and ns3::Socket::ShutdownRecv().
|
overrideprivatevirtual |
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 210 of file bulk-send-application.cc.
References ns3::Socket::Close(), m_connected, m_socket, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
private |
True if connected.
Definition at line 118 of file bulk-send-application.h.
Referenced by ConnectionSucceeded(), DataSend(), SendData(), StartApplication(), and StopApplication().
|
private |
Enable or disable the SeqTsSizeHeader.
Definition at line 126 of file bulk-send-application.h.
Referenced by GetTypeId(), and SendData().
|
private |
Local address to bind to.
Definition at line 117 of file bulk-send-application.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
Limit total number of bytes sent.
Definition at line 121 of file bulk-send-application.h.
Referenced by GetTypeId(), SendData(), and SetMaxBytes().
|
private |
Peer address.
Definition at line 116 of file bulk-send-application.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
Traced Callback: retransmitted packets.
Definition at line 137 of file bulk-send-application.h.
Referenced by GetTypeId(), and PacketRetransmitted().
|
private |
Size of data to send each time.
Definition at line 120 of file bulk-send-application.h.
Referenced by GetTypeId(), and SendData().
|
private |
Associated socket.
Definition at line 115 of file bulk-send-application.h.
Referenced by DoDispose(), GetSocket(), SendData(), StartApplication(), and StopApplication().
|
private |
The type of protocol to use.
Definition at line 123 of file bulk-send-application.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
The packets Type of Service.
Definition at line 119 of file bulk-send-application.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
Total bytes sent so far.
Definition at line 122 of file bulk-send-application.h.
Referenced by SendData().
|
private |
Traced Callback: sent packets.
Definition at line 129 of file bulk-send-application.h.
Referenced by GetTypeId(), and SendData().
|
private |
Callback for tracing the packet Tx events, includes source, destination, the packet sent, and header.
Definition at line 142 of file bulk-send-application.h.
Referenced by GetTypeId(), and SendData().
Variable to cache unsent packet.
Definition at line 125 of file bulk-send-application.h.
Referenced by DoDispose(), and SendData().