A Udp Echo client. More...

#include "udp-echo-client.h"

Inheritance diagram for ns3::UdpEchoClient:

Collaboration diagram for ns3::UdpEchoClient:

Public Member Functions
	UdpEchoClient ()

	~UdpEchoClient () override

uint32_t	GetDataSize () const
	Get the number of data bytes that will be sent to the server.

void	SetDataSize (uint32_t dataSize)
	Set the data size of the packet (the number of bytes that are sent as data to the server).

void	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.

void	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.

void	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.

void	SetRemote (Address addr)
	set the remote address

void	SetRemote (Address ip, uint16_t port)
	set the remote address and port

Public Member Functions inherited from ns3::Application
	Application ()

	~Application () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this Application object.

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 ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
void	HandleRead (Ptr< Socket > socket)
	Handle a packet reception.

void	ScheduleTransmit (Time dt)
	Schedule the next packet transmission.

void	Send ()
	Send a packet.

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
uint32_t	m_count
	Maximum number of packets the application will send.

uint8_t *	m_data
	packet payload data

uint32_t	m_dataSize
	packet payload size (must be equal to m_size)

Time	m_interval
	Packet inter-send time.

Address	m_peerAddress
	Remote peer address.

uint16_t	m_peerPort
	Remote peer port.

TracedCallback< Ptr< const Packet > >	m_rxTrace
	Callbacks for tracing the packet Rx events.

TracedCallback< Ptr< const Packet >, const Address &, const Address & >	m_rxTraceWithAddresses
	Callbacks for tracing the packet Rx events, includes source and destination addresses.

EventId	m_sendEvent
	Event to send the next packet.

uint32_t	m_sent
	Counter for sent packets.

uint32_t	m_size
	Size of the sent packet.

Ptr< Socket >	m_socket
	Socket.

uint8_t	m_tos
	The packets Type of Service.

TracedCallback< Ptr< const Packet > >	m_txTrace
	Callbacks for tracing the packet Tx events.

TracedCallback< Ptr< const Packet >, const Address &, const Address & >	m_txTraceWithAddresses
	Callbacks for tracing the packet Tx events, includes source and destination addresses.

Additional Inherited Members
Public Types inherited from ns3::Application
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address.

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source.

Protected Member Functions inherited from ns3::Application
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
	The node that this application is installed on.

EventId	m_startEvent
	The event that will fire at m_startTime to start the application.

Time	m_startTime
	The simulation time that the application will start.

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application.

Time	m_stopTime
	The simulation time that the application will end.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A Udp Echo client.

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

Config Paths

ns3::UdpEchoClient is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes

Interval: The time to wait between packets
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1e+09ns
- Flags: constructwriteread
MaxPackets: The maximum number of packets the application will send (zero means infinite)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 100
- Flags: constructwriteread
PacketSize: Size of echo data in outbound packets
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 100
- Flags: constructwriteread
RemoteAddress: The destination Address of the outbound packets
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
RemotePort: The destination port of the outbound packets
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: constructwriteread
Tos: The Type of Service used to send IPv4 packets. All 8 bits of the TOS byte are set (including ECN bits).
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread

TraceSources

Rx: A packet has been received
Callback signature: ns3::Packet::TracedCallback
RxWithAddresses: A packet has been received
Callback signature: ns3::Packet::TwoAddressTracedCallback
Tx: A new packet is created and is sent
Callback signature: ns3::Packet::TracedCallback
TxWithAddresses: A new packet is created and is sent
Callback signature: ns3::Packet::TwoAddressTracedCallback

Size of this type is 296 bytes (on a 64-bit architecture).

Definition at line 39 of file udp-echo-client.h.

Constructor & Destructor Documentation

◆ UdpEchoClient()

ns3::UdpEchoClient::UdpEchoClient ( )

Definition at line 99 of file udp-echo-client.cc.

References m_data, m_dataSize, m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.

◆ ~UdpEchoClient()

ns3::UdpEchoClient::~UdpEchoClient ( )

override

Definition at line 109 of file udp-echo-client.cc.

References m_data, m_dataSize, m_socket, and NS_LOG_FUNCTION.

Member Function Documentation

◆ GetDataSize()

uint32_t ns3::UdpEchoClient::GetDataSize ( ) 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.

Definition at line 223 of file udp-echo-client.cc.

References m_size, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::UdpEchoClient::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 40 of file udp-echo-client.cc.

References GetDataSize(), m_count, m_interval, m_peerAddress, m_peerPort, m_rxTrace, m_rxTraceWithAddresses, m_tos, m_txTrace, m_txTraceWithAddresses, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), SetDataSize(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleRead()

void ns3::UdpEchoClient::HandleRead ( Ptr< Socket > socket )

private

Handle a packet reception.

This function is called by lower layers.

Parameters

socket the socket the packet was received to.

Definition at line 404 of file udp-echo-client.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_rxTrace, m_rxTraceWithAddresses, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Time::S.

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleTransmit()

void ns3::UdpEchoClient::ScheduleTransmit ( Time dt )

private

Schedule the next packet transmission.

Parameters

dt	time interval between packets.

Definition at line 310 of file udp-echo-client.cc.

References m_sendEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and Send().

Referenced by Send(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

void ns3::UdpEchoClient::Send ( )

private

Send a packet.

Definition at line 317 of file udp-echo-client.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::GetSockName(), ns3::EventId::IsExpired(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_count, m_data, m_dataSize, m_interval, m_peerAddress, m_peerPort, m_sendEvent, m_sent, m_size, m_socket, m_txTrace, m_txTraceWithAddresses, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::S, ScheduleTransmit(), and ns3::Socket::Send().

Referenced by ScheduleTransmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDataSize()

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.

Definition at line 207 of file udp-echo-client.cc.

References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetFill() [1/3]

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.

Definition at line 230 of file udp-echo-client.cc.

References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.

◆ SetFill() [2/3]

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.

Definition at line 271 of file udp-echo-client.cc.

References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.

◆ SetFill() [3/3]

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.

Definition at line 252 of file udp-echo-client.cc.

References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.

◆ SetRemote() [1/2]

void ns3::UdpEchoClient::SetRemote ( Address addr )

set the remote address

Parameters

addr	remote address

Definition at line 128 of file udp-echo-client.cc.

References m_peerAddress, and NS_LOG_FUNCTION.

◆ SetRemote() [2/2]

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

set the remote address and port

Parameters

ip	remote IP address
port	remote port

Definition at line 120 of file udp-echo-client.cc.

References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

◆ StartApplication()

void ns3::UdpEchoClient::StartApplication ( )

overrideprivatevirtual

Application specific startup code.

The StartApplication method is called at the start time specified by Start This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 135 of file udp-echo-client.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleRead(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_socket, m_tos, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ScheduleTransmit(), ns3::Seconds(), ns3::Socket::SetAllowBroadcast(), ns3::Socket::SetIpTos(), and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

◆ StopApplication()

void ns3::UdpEchoClient::StopApplication ( )

overrideprivatevirtual

Application specific shutdown code.

The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 192 of file udp-echo-client.cc.

References ns3::Simulator::Cancel(), ns3::Socket::Close(), m_sendEvent, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

Member Data Documentation

◆ m_count

uint32_t ns3::UdpEchoClient::m_count

private

Maximum number of packets the application will send.

Definition at line 156 of file udp-echo-client.h.

Referenced by GetTypeId(), and Send().

◆ m_data

uint8_t* ns3::UdpEchoClient::m_data

private

packet payload data

Definition at line 161 of file udp-echo-client.h.

Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), SetDataSize(), and SetFill().

◆ m_dataSize

uint32_t ns3::UdpEchoClient::m_dataSize

private

packet payload size (must be equal to m_size)

Definition at line 160 of file udp-echo-client.h.

Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), SetDataSize(), and SetFill().

◆ m_interval

Time ns3::UdpEchoClient::m_interval

private

Packet inter-send time.

Definition at line 157 of file udp-echo-client.h.

Referenced by GetTypeId(), and Send().

◆ m_peerAddress

Address ns3::UdpEchoClient::m_peerAddress

private

Remote peer address.

Definition at line 165 of file udp-echo-client.h.

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

◆ m_peerPort

uint16_t ns3::UdpEchoClient::m_peerPort

private

Remote peer port.

Definition at line 166 of file udp-echo-client.h.

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

◆ m_rxTrace

TracedCallback<Ptr<const Packet> > ns3::UdpEchoClient::m_rxTrace

private

Callbacks for tracing the packet Rx events.

Definition at line 174 of file udp-echo-client.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_rxTraceWithAddresses

TracedCallback<Ptr<const Packet>, const Address&, const Address&> ns3::UdpEchoClient::m_rxTraceWithAddresses

private

Callbacks for tracing the packet Rx events, includes source and destination addresses.

Definition at line 180 of file udp-echo-client.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_sendEvent

EventId ns3::UdpEchoClient::m_sendEvent

private

Event to send the next packet.

Definition at line 168 of file udp-echo-client.h.

Referenced by UdpEchoClient(), ScheduleTransmit(), Send(), and StopApplication().

◆ m_sent

uint32_t ns3::UdpEchoClient::m_sent

private

Counter for sent packets.

Definition at line 163 of file udp-echo-client.h.

Referenced by UdpEchoClient(), and Send().

◆ m_size

uint32_t ns3::UdpEchoClient::m_size

private

Size of the sent packet.

Definition at line 158 of file udp-echo-client.h.

Referenced by GetDataSize(), Send(), SetDataSize(), and SetFill().

◆ m_socket

Ptr<Socket> ns3::UdpEchoClient::m_socket

private

Socket.

Definition at line 164 of file udp-echo-client.h.

Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), StartApplication(), and StopApplication().

◆ m_tos

uint8_t ns3::UdpEchoClient::m_tos

private

The packets Type of Service.

Definition at line 167 of file udp-echo-client.h.

Referenced by GetTypeId(), and StartApplication().

◆ m_txTrace

TracedCallback<Ptr<const Packet> > ns3::UdpEchoClient::m_txTrace

private

Callbacks for tracing the packet Tx events.

Definition at line 171 of file udp-echo-client.h.

Referenced by GetTypeId(), and Send().

◆ m_txTraceWithAddresses

TracedCallback<Ptr<const Packet>, const Address&, const Address&> ns3::UdpEchoClient::m_txTraceWithAddresses

private

Callbacks for tracing the packet Tx events, includes source and destination addresses.

Definition at line 177 of file udp-echo-client.h.

Referenced by GetTypeId(), and Send().

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

src/applications/model/udp-echo-client.h
src/applications/model/udp-echo-client.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Application

TraceSources

Constructor & Destructor Documentation

◆ UdpEchoClient()

◆ ~UdpEchoClient()

Member Function Documentation

◆ GetDataSize()

◆ GetTypeId()

◆ HandleRead()

◆ ScheduleTransmit()

◆ Send()

◆ SetDataSize()

◆ SetFill() [1/3]

◆ SetFill() [2/3]

◆ SetFill() [3/3]

◆ SetRemote() [1/2]

◆ SetRemote() [2/2]

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_count

◆ m_data

◆ m_dataSize

◆ m_interval

◆ m_peerAddress

◆ m_peerPort

◆ m_rxTrace

◆ m_rxTraceWithAddresses

◆ m_sendEvent

◆ m_sent

◆ m_size

◆ m_socket

◆ m_tos

◆ m_txTrace

◆ m_txTraceWithAddresses