ns3::UdpClient Class Reference [UdpClientServer]

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:

List of all members.

Public Member Functions
void	SetRemote (Ipv4Address ip, uint16_t port)
	set the remote address and port
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::UdpClient.
Protected Member Functions
virtual void	DoDispose (void)

---

Detailed Description

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

---

Member Function Documentation

virtual void ns3::UdpClient::DoDispose

(

void

)

[protected, virtual]

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.

static 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
  • 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: 1000000000ns
  • Flags: construct write read
• RemoteAddress: The destination Ipv4Address of the outbound packets
  • Set with class: Ipv4AddressValue
  • Underlying type: Ipv4Address
  • Initial value: 102.102.102.102
  • 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: 0ns
  • Flags: construct write read
• StopTime: Time at which the application will stop
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 0ns
  • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Application.

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

set the remote address and port

Parameters:

	ip	remote IP address
	port	remote port

---

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

• src/applications/udp-client-server/udp-client.h
• doc/introspected-doxygen.h