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< 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 ()
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
SimpleRefCount &	operator= (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)

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< Socket >	m_socket

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

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: 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
- 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:1500
- 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: 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 are defined for this type.

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.

ns3::UdpClient::~UdpClient ( )

virtual

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

References NS_LOG_FUNCTION.

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 113 of file udp-client.cc.

References NS_LOG_FUNCTION.

TypeId ns3::UdpClient::GetTypeId ( void )

static

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: