Public Member Functions | Static Public Member Functions | Protected Member Functions

ns3::UdpEchoClient Class Reference
[UdpEcho]

A Udp Echo client. More...

#include <udp-echo-client.h>

Inheritance diagram for ns3::UdpEchoClient:
Inheritance graph
[legend]
Collaboration diagram for ns3::UdpEchoClient:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void SetRemote (Ipv4Address ip, uint16_t port)
void SetDataSize (uint32_t dataSize)
uint32_t GetDataSize (void) const
void SetFill (std::string fill)
void SetFill (uint8_t fill, uint32_t dataSize)
void SetFill (uint8_t *fill, uint32_t fillSize, uint32_t dataSize)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::UdpEchoClient.

Protected Member Functions

virtual void DoDispose (void)

Detailed Description

A Udp Echo client.

Every packet sent should be returned by the server and received here.

Member Function Documentation

virtual void ns3::UdpEchoClient::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.

uint32_t ns3::UdpEchoClient::GetDataSize ( void   )  const

Get the number of data bytes that will be sent to the server.

Warning:
The number of bytes may be modified by calling any one of the SetFill methods. If you have called SetFill, then the number of data bytes will correspond to the size of an initialized data buffer. If you have not called a SetFill method, the number of data bytes will correspond to the number of don't care bytes that will be sent.
Returns:
The number of data bytes.
static TypeId ns3::UdpEchoClient::GetTypeId ( void   )  [static]

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

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

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

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: 1000000000ns
    • Flags: construct write read
  • RemoteAddress: The destination Ipv4Address of the outbound packets
  • RemotePort: The destination port of the outbound packets
  • PacketSize: Size of echo data in outbound packets

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

TraceSources defined for this type:

  • Tx: A new packet is created and is sent

Reimplemented from ns3::Application.

void ns3::UdpEchoClient::SetDataSize ( uint32_t  dataSize  ) 

Set the data size of the packet (the number of bytes that are sent as data to the server). The contents of the data are set to unspecified (don't care) by this call.

Warning:
If you have set the fill data for the echo client using one of the SetFill calls, this will undo those effects.
Parameters:
dataSize The size of the echo data you want to sent.
void ns3::UdpEchoClient::SetFill ( std::string  fill  ) 

Set the data fill of the packet (what is sent as data to the server) to the zero-terminated contents of the fill string string.

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:
fill The string to use as the actual echo data bytes.
void ns3::UdpEchoClient::SetFill ( uint8_t *  fill,
uint32_t  fillSize,
uint32_t  dataSize 
)

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 packet to the contents of a provided single buffer is accomplished by setting the fillSize set to your desired dataSize (and providing an appropriate buffer).

Warning:
The size of resulting echo packets will be automatically adjusted to reflect the dataSize parameter -- this means that the PacketSize attribute of the Application may be changed as a result of this call.
Parameters:
fill The fill pattern to use when constructing packets.
fillSize The number of bytes in the provided fill pattern.
dataSize The desired size of the final echo data.
void ns3::UdpEchoClient::SetFill ( uint8_t  fill,
uint32_t  dataSize 
)

Set the data fill of the packet (what is sent as data to the server) to the repeated contents of the fill byte. i.e., 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 dataSize parameter -- this means that the PacketSize attribute may be changed as a result of this call.
Parameters:
fill The byte to be repeated in constructing the packet data..
dataSize The desired size of the resulting echo packet data.
The documentation for this class was generated from the following files:
Generated on Fri Feb 18 2011 17:01:45 for NS-3 by  doxygen 1.7.1