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

A Udp client. More...

#include "udp-client.h"

+ Inheritance diagram for ns3::UdpClient:
+ Collaboration diagram for ns3::UdpClient:

Public Member Functions

 UdpClient ()
 
virtual ~UdpClient ()
 
uint64_t GetTotalTx () const
 
void SetRemote (Address addr)
 set the remote address More...
 
void SetRemote (Address ip, uint16_t port)
 set the remote address and port 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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 Send (void)
 Send a packet. More...
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

uint32_t m_count
 Maximum number of packets the application will send. More...
 
Time m_interval
 Packet inter-send time. More...
 
Address m_peerAddress
 Remote peer address. More...
 
std::string m_peerAddressString
 Remote peer address string. More...
 
uint16_t m_peerPort
 Remote peer port. More...
 
EventId m_sendEvent
 Event to send the next packet. More...
 
uint32_t m_sent
 Counter for sent packets. More...
 
uint32_t m_size
 Size of the sent packet (including the SeqTsHeader) More...
 
Ptr< Socketm_socket
 Socket. More...
 
uint64_t m_totalTx
 Total bytes sent. 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

A Udp client.

Sends UDP packet carrying sequence number and time stamp in their payloads

Config Paths

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

  • "/NodeList/[i]/ApplicationList/[i]/$ns3::UdpClient"

Attributes

  • MaxPackets: The maximum number of packets the application will send
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 100
    • Flags: construct write read
  • Interval: The time to wait between packets
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +1e+09ns
    • Flags: construct write read
  • RemoteAddress: The destination Address of the outbound packets
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • RemotePort: The destination port of the outbound packets
    • Set with class: ns3::UintegerValue
    • Underlying type: uint16_t 0:65535
    • Initial value: 100
    • Flags: construct write read
  • PacketSize: Size of packets generated. The minimum packet size is 12 bytes which is the size of the header carrying the sequence number and the time stamp.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 12:65507
    • Initial value: 1024
    • 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

No TraceSources are defined for this type.
Size of this type is 200 bytes (on a 64-bit architecture).

Definition at line 43 of file udp-client.h.

Constructor & Destructor Documentation

◆ UdpClient()

ns3::UdpClient::UdpClient ( )

Definition at line 76 of file udp-client.cc.

References m_sendEvent, m_sent, m_socket, m_totalTx, and NS_LOG_FUNCTION.

◆ ~UdpClient()

ns3::UdpClient::~UdpClient ( )
virtual

Definition at line 85 of file udp-client.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::UdpClient::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 106 of file udp-client.cc.

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

+ Here is the call graph for this function:

◆ GetTotalTx()

uint64_t ns3::UdpClient::GetTotalTx ( ) const
Returns
the total bytes sent by this app

Definition at line 221 of file udp-client.cc.

References m_totalTx.

◆ GetTypeId()

TypeId ns3::UdpClient::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 43 of file udp-client.cc.

References m_count, m_interval, m_peerAddress, m_peerPort, m_size, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

Referenced by ns3::UdpClientHelper::UdpClientHelper().

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

◆ Send()

void ns3::UdpClient::Send ( void  )
private

◆ SetRemote() [1/2]

void ns3::UdpClient::SetRemote ( Address  addr)

set the remote address

Parameters
addrremote address

Definition at line 99 of file udp-client.cc.

References m_peerAddress, and NS_LOG_FUNCTION.

◆ SetRemote() [2/2]

void ns3::UdpClient::SetRemote ( Address  ip,
uint16_t  port 
)

set the remote address and port

Parameters
ipremote IP address
portremote port

Definition at line 91 of file udp-client.cc.

References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

◆ StartApplication()

◆ StopApplication()

void ns3::UdpClient::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 178 of file udp-client.cc.

References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_count

uint32_t ns3::UdpClient::m_count
private

Maximum number of packets the application will send.

Definition at line 86 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_interval

Time ns3::UdpClient::m_interval
private

Packet inter-send time.

Definition at line 87 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_peerAddress

Address ns3::UdpClient::m_peerAddress
private

Remote peer address.

Definition at line 93 of file udp-client.h.

Referenced by GetTypeId(), SetRemote(), and StartApplication().

◆ m_peerAddressString

std::string ns3::UdpClient::m_peerAddressString
private

Remote peer address string.

Definition at line 97 of file udp-client.h.

Referenced by Send(), and StartApplication().

◆ m_peerPort

uint16_t ns3::UdpClient::m_peerPort
private

Remote peer port.

Definition at line 94 of file udp-client.h.

Referenced by GetTypeId(), SetRemote(), and StartApplication().

◆ m_sendEvent

EventId ns3::UdpClient::m_sendEvent
private

Event to send the next packet.

Definition at line 95 of file udp-client.h.

Referenced by UdpClient(), Send(), StartApplication(), and StopApplication().

◆ m_sent

uint32_t ns3::UdpClient::m_sent
private

Counter for sent packets.

Definition at line 90 of file udp-client.h.

Referenced by UdpClient(), and Send().

◆ m_size

uint32_t ns3::UdpClient::m_size
private

Size of the sent packet (including the SeqTsHeader)

Definition at line 88 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_socket

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

Socket.

Definition at line 92 of file udp-client.h.

Referenced by UdpClient(), Send(), and StartApplication().

◆ m_totalTx

uint64_t ns3::UdpClient::m_totalTx
private

Total bytes sent.

Definition at line 91 of file udp-client.h.

Referenced by UdpClient(), GetTotalTx(), and Send().


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