A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UdpClient Class Reference

A Udp client. Sends UDP packet carrying sequence number and time stamp in their payloads. More...

#include <udp-client.h>

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

Public Member Functions

 UdpClient ()
virtual ~UdpClient ()
void SetRemote (Ipv4Address ip, uint16_t port)
 set the remote address and port
void SetRemote (Ipv6Address ip, uint16_t port)
void SetRemote (Address ip, uint16_t port)
- 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.
void SetStopTime (Time stop)
 Specify application stop time.
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~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)
 This method returns the TypeId associated to ns3::UdpClient.

Protected Member Functions

virtual void DoDispose (void)
- Protected Member Functions inherited from ns3::Application
virtual void DoStart (void)
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void NotifyNewAggregate (void)

Private Member Functions

void ScheduleTransmit (Time dt)
void Send (void)
virtual void StartApplication (void)
virtual void StopApplication (void)

Private Attributes

uint32_t m_count
Time m_interval
Address m_peerAddress
uint16_t m_peerPort
EventId m_sendEvent
uint32_t m_sent
uint32_t m_size
Ptr< Socketm_socket

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
EventId m_startEvent
Time m_startTime
EventId m_stopEvent
Time m_stopTime

Detailed Description

A Udp client. Sends UDP packet carrying sequence number and time stamp in their payloads.

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

Constructor & Destructor Documentation

ns3::UdpClient::UdpClient ( )

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

References m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION_NOARGS.

ns3::UdpClient::~UdpClient ( )
virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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

References NS_LOG_FUNCTION_NOARGS.

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

This method returns the TypeId associated to ns3::UdpClient.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

  • MaxPackets: The maximum number of packets the application will send
  • Interval: The time to wait between packets
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • 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
  • 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.

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

No TraceSources defined for this type.

Reimplemented from ns3::Application.

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

References m_count, m_interval, m_peerAddress, m_peerPort, m_size, 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:

void ns3::UdpClient::ScheduleTransmit ( Time  dt)
private
void ns3::UdpClient::SetRemote ( Ipv4Address  ip,
uint16_t  port 
)

set the remote address and port

Parameters
ipremote IP address
portremote port

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

References m_peerAddress, m_peerPort, and port.

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

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

References m_peerAddress, m_peerPort, and port.

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

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

References m_peerAddress, m_peerPort, and port.

void ns3::UdpClient::StopApplication ( void  )
privatevirtual

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

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

+ Here is the call graph for this function:

Member Data Documentation

uint32_t ns3::UdpClient::m_count
private

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

Referenced by GetTypeId(), and Send().

Time ns3::UdpClient::m_interval
private

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

Referenced by GetTypeId(), and Send().

Address ns3::UdpClient::m_peerAddress
private

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

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

uint16_t ns3::UdpClient::m_peerPort
private

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

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

EventId ns3::UdpClient::m_sendEvent
private

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

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

uint32_t ns3::UdpClient::m_sent
private

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

Referenced by Send(), and UdpClient().

uint32_t ns3::UdpClient::m_size
private

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

Referenced by GetTypeId(), and Send().

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

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

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


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