A Udp client. More...

#include "udp-client.h"

Inheritance diagram for ns3::UdpClient:

Collaboration diagram for ns3::UdpClient:

Public Member Functions
	UdpClient ()

	~UdpClient () override

uint64_t	GetTotalTx () const

void	SetRemote (const Address &addr) override
	set the remote address

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

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

	~SourceApplication () override

Address	GetRemote () const
	get the remote address

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 final
	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, bool permissive=false) 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.

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::SourceApplication
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.

Static Public Attributes
static constexpr uint16_t	DEFAULT_PORT {100}
	default port

Private Member Functions
uint16_t	GetPort () const
	Get the remote port (temporary function until deprecated attributes are removed)

Address	GetRemote () const
	Get the remote address (temporary function until deprecated attributes are removed)

void	Send ()
	Send a packet.

void	SetPort (uint16_t port)
	Set the remote port (temporary function until deprecated attributes are removed)

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.

Time	m_interval
	Packet inter-send time.

std::optional< uint16_t >	m_peerPort
	Remote peer port (deprecated) // NS_DEPRECATED_3_44.

std::string	m_peerString
	Remote peer address string.

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 (including the SeqTsHeader)

Ptr< Socket >	m_socket
	Socket.

uint64_t	m_totalTx
	Total bytes sent.

TracedCallback< Ptr< const Packet > >	m_txTrace
	Traced Callback: transmitted packets.

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	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::SourceApplication
Address	m_local
	Local address to bind to.

Address	m_peer
	Peer address.

uint8_t	m_tos
	The packets Type of Service.

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 Symbols 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 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::SourceApplication/$ns3::UdpClient"
"/NodeList/[i]/ApplicationList/[i]/$ns3::UdpClient"

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
- Support level: SUPPORTED
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
- Support level: SUPPORTED
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:65507
- Initial value: 1024
- Flags: constructwriteread
- Support level: SUPPORTED
RemoteAddress: The destination Address of the outbound packets
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: DEPRECATED: Replaced by Remote in ns-3.44.
RemotePort: The destination port of the outbound packets
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 100
- Flags: constructwriteread
- Support level: DEPRECATED: Replaced by Remote in ns-3.44.

Attributes defined in parent class ns3::SourceApplication

Local: The Address on which to bind the socket. If not set, it is generated automatically when needed by the application.
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
Remote: The address of the destination, made of the remote IP address and the destination port
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
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
- Support level: SUPPORTED

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
- Support level: SUPPORTED
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
- Support level: SUPPORTED

TraceSources

Tx: A new packet is created and sent
- Callback signature: ns3::Packet::TracedCallback
- Support level: SUPPORTED
TxWithAddresses: A new packet is created and sent
- Callback signature: ns3::Packet::TwoAddressTracedCallback
- Support level: SUPPORTED

Group: Applications

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

Definition at line 37 of file udp-client.h.

Constructor & Destructor Documentation

◆ UdpClient()

ns3::UdpClient::UdpClient ( )

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

References NS_LOG_FUNCTION.

◆ ~UdpClient()

ns3::UdpClient::~UdpClient ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetPort()

uint16_t ns3::UdpClient::GetPort ( ) const

private

Get the remote port (temporary function until deprecated attributes are removed)

Returns: the remote port

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

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), DEFAULT_PORT, ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::GetPort(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::SourceApplication::m_peer, and m_peerPort.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRemote()

Address ns3::UdpClient::GetRemote ( ) const

private

Get the remote address (temporary function until deprecated attributes are removed)

Returns: the remote address

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

References ns3::SourceApplication::m_peer.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTotalTx()

uint64_t ns3::UdpClient::GetTotalTx ( ) const

Returns: the total bytes sent by this app

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

References m_totalTx.

◆ GetTypeId()

TypeId ns3::UdpClient::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References DEFAULT_PORT, ns3::TypeId::DEPRECATED, GetPort(), GetRemote(), m_count, m_interval, m_size, m_txTrace, m_txTraceWithAddresses, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Seconds(), ns3::TypeId::SetParent(), SetPort(), and SetRemote().

Here is the call graph for this function:

◆ Send()

void ns3::UdpClient::Send ( )

private

Send a packet.

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

References ns3::Create(), ns3::Socket::GetPeerName(), ns3::SeqTsHeader::GetSerializedSize(), ns3::Socket::GetSockName(), ns3::EventId::IsExpired(), m_count, m_interval, m_peerString, m_sendEvent, m_sent, m_size, m_socket, m_totalTx, m_txTrace, m_txTraceWithAddresses, ns3::Simulator::Now(), NS_ABORT_IF, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::S, ns3::Simulator::Schedule(), ns3::Socket::Send(), Send(), and ns3::SeqTsHeader::SetSeq().

Referenced by Send(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPort()

void ns3::UdpClient::SetPort ( uint16_t port )

private

Set the remote port (temporary function until deprecated attributes are removed)

Parameters

port	remote port

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

References ns3::addressUtils::ConvertToSocketAddress(), ns3::Address::IsInvalid(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and port.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRemote() [1/2]

void ns3::UdpClient::SetRemote ( const Address & addr )

overridevirtual

set the remote address

Parameters

addr	remote address

Reimplemented from ns3::SourceApplication.

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

References ns3::Address::IsInvalid(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and SetPort().

Here is the call graph for this function:

◆ SetRemote() [2/2]

void ns3::UdpClient::SetRemote	(	const Address &	ip,
		uint16_t	port )

set the remote address and port

Parameters

ip	remote IP address
port	remote port

Deprecated: "Deprecated in ns-3.44: " "Use SetRemote without port parameter instead"

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

References NS_LOG_FUNCTION, port, SetPort(), and SetRemote().

Referenced by GetTypeId(), and SetRemote().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartApplication()

void ns3::UdpClient::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 167 of file udp-client.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::Application::GetNode(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::GetPort(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::TypeId::LookupByName(), ns3::SourceApplication::m_local, ns3::SourceApplication::m_peer, m_peerString, m_sendEvent, m_socket, ns3::SourceApplication::m_tos, ns3::MakeNullCallback(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Seconds(), Send(), ns3::Socket::SetAllowBroadcast(), ns3::Socket::SetIpTos(), and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

◆ StopApplication()

void ns3::UdpClient::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 235 of file udp-client.cc.

References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ DEFAULT_PORT

uint16_t ns3::UdpClient::DEFAULT_PORT {100}

staticconstexpr

default port

Definition at line 49 of file udp-client.h.

Referenced by GetPort(), and GetTypeId().

◆ m_count

uint32_t ns3::UdpClient::m_count

private

Maximum number of packets the application will send.

Definition at line 98 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_interval

Time ns3::UdpClient::m_interval

private

Packet inter-send time.

Definition at line 99 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_peerPort

std::optional<uint16_t> ns3::UdpClient::m_peerPort

private

Remote peer port (deprecated) // NS_DEPRECATED_3_44.

Definition at line 105 of file udp-client.h.

Referenced by GetPort(), SetPort(), and SetRemote().

◆ m_peerString

std::string ns3::UdpClient::m_peerString

private

Remote peer address string.

Definition at line 109 of file udp-client.h.

Referenced by Send(), and StartApplication().

◆ m_sendEvent

EventId ns3::UdpClient::m_sendEvent

private

Event to send the next packet.

Definition at line 106 of file udp-client.h.

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

◆ m_sent

uint32_t ns3::UdpClient::m_sent

private

Counter for sent packets.

Definition at line 102 of file udp-client.h.

Referenced by Send().

◆ m_size

uint32_t ns3::UdpClient::m_size

private

Size of the sent packet (including the SeqTsHeader)

Definition at line 100 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_socket

Ptr<Socket> ns3::UdpClient::m_socket

private

Socket.

Definition at line 104 of file udp-client.h.

Referenced by Send(), and StartApplication().

◆ m_totalTx

uint64_t ns3::UdpClient::m_totalTx

private

Total bytes sent.

Definition at line 103 of file udp-client.h.

Referenced by GetTotalTx(), and Send().

◆ m_txTrace

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

private

Traced Callback: transmitted packets.

Definition at line 93 of file udp-client.h.

Referenced by GetTypeId(), and Send().

◆ m_txTraceWithAddresses

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

private

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

Definition at line 96 of file udp-client.h.

Referenced by GetTypeId(), and Send().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::SourceApplication

Attributes defined in parent class ns3::Application

TraceSources

Constructor & Destructor Documentation

◆ UdpClient()

◆ ~UdpClient()

Member Function Documentation

◆ GetPort()

◆ GetRemote()

◆ GetTotalTx()

◆ GetTypeId()

◆ Send()

◆ SetPort()

◆ SetRemote() [1/2]

◆ SetRemote() [2/2]

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ DEFAULT_PORT

◆ m_count

◆ m_interval

◆ m_peerPort

◆ m_peerString

◆ m_sendEvent

◆ m_sent

◆ m_size

◆ m_socket

◆ m_totalTx

◆ m_txTrace

◆ m_txTraceWithAddresses