ns3::UdpEchoClientHelper Class Reference

create an application which sends a udp packet and waits for an echo of this packet More...

#include <udp-echo-helper.h>

Collaboration diagram for ns3::UdpEchoClientHelper:

List of all members.

Public Member Functions
	UdpEchoClientHelper (Ipv4Address ip, uint16_t port)
void	SetAttribute (std::string name, const AttributeValue &value)
void	SetFill (Ptr< Application > app, std::string fill)
void	SetFill (Ptr< Application > app, uint8_t fill, uint32_t dataLength)
void	SetFill (Ptr< Application > app, uint8_t *fill, uint32_t fillLength, uint32_t dataLength)
ApplicationContainer	Install (Ptr< Node > node) const
ApplicationContainer	Install (std::string nodeName) const
ApplicationContainer	Install (NodeContainer c) const

---

Detailed Description

create an application which sends a udp packet and waits for an echo of this packet

---

Constructor & Destructor Documentation

ns3::UdpEchoClientHelper::UdpEchoClientHelper	(	Ipv4Address	ip,
		uint16_t	port
	)

Create UdpEchoClientHelper which will make life easier for people trying to set up simulations with echos.

Parameters:

	ip	The IP address of the remote udp echo server
	port	The port number of the remote udp echo server

---

Member Function Documentation

ApplicationContainer ns3::UdpEchoClientHelper::Install

(

Ptr< Node >

node

)

const

Create a udp echo client application on the specified node. The Node is provided as a Ptr<Node>.

Parameters:

node

The Ptr<Node> on which to create the UdpEchoClientApplication.

Returns:

An ApplicationContainer that holds a Ptr<Application> to the application created

ApplicationContainer ns3::UdpEchoClientHelper::Install

(

NodeContainer

c

)

const

Parameters:

c

the nodes

Create one udp echo client application on each of the input nodes

Returns:

the applications created, one application per input node.

ApplicationContainer ns3::UdpEchoClientHelper::Install

(

std::string

nodeName

)

const

Create a udp echo client application on the specified node. The Node is provided as a string name of a Node that has been previously associated using the Object Name Service.

Parameters:

nodeName

The name of the node on which to create the UdpEchoClientApplication

Returns:

An ApplicationContainer that holds a Ptr<Application> to the application created

void ns3::UdpEchoClientHelper::SetAttribute	(	std::string	name,
		const AttributeValue &	value
	)

Record an attribute to be set in each Application after it is is created.

Parameters:

	name	the name of the attribute to set
	value	the value of the attribute to set

void ns3::UdpEchoClientHelper::SetFill	(	Ptr< Application >	app,
		uint8_t *	fill,
		uint32_t	fillLength,
		uint32_t	dataLength
	)

Given a pointer to a UdpEchoClient application, set the data fill of the packet (what is sent as data to the server) to the contents of the fill buffer, repeated as many times as is required.

Initializing the fill to the contents of a single buffer is accomplished by providing a complete buffer with fillLength set to your desired dataLength

Warning:

The size of resulting echo packets will be automatically adjusted to reflect the dataLength parameter -- this means that the PacketSize attribute of the Application may be changed as a result of this call.

Parameters:

	app	Smart pointer to the application (real type must be UdpEchoClient).
	fill	The fill pattern to use when constructing packets.
	fillLength	The number of bytes in the provided fill pattern.
	dataLength	The desired length of the final echo data.

void ns3::UdpEchoClientHelper::SetFill	(	Ptr< Application >	app,
		uint8_t	fill,
		uint32_t	dataLength
	)

Given a pointer to a UdpEchoClient application, set the data fill of the packet (what is sent as data to the server) to the contents of the fill byte.

The fill byte will be used to initialize the contents of the data packet.

Warning:

The size of resulting echo packets will be automatically adjusted to reflect the dataLength parameter -- this means that the PacketSize attribute may be changed as a result of this call.

Parameters:

	app	Smart pointer to the application (real type must be UdpEchoClient).
	fill	The byte to be repeated in constructing the packet data..
	dataLength	The desired length of the resulting echo packet data.

void ns3::UdpEchoClientHelper::SetFill	(	Ptr< Application >	app,
		std::string	fill
	)

Given a pointer to a UdpEchoClient application, set the data fill of the packet (what is sent as data to the server) to the contents of the fill string (including the trailing zero terminator).

Warning:

The size of resulting echo packets will be automatically adjusted to reflect the size of the fill string -- this means that the PacketSize attribute may be changed as a result of this call.

Parameters:

	app	Smart pointer to the application (real type must be UdpEchoClient).
	fill	The string to use as the actual echo data bytes.

---

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

• src/helper/udp-echo-helper.h