A UDP server, receives UDP packets from a remote host. More...

#include "udp-server.h"

Inheritance diagram for ns3::UdpServer:

Collaboration diagram for ns3::UdpServer:

Public Member Functions
	UdpServer ()

	~UdpServer () override

uint32_t	GetLost () const
	Returns the number of lost packets.

uint16_t	GetPacketWindowSize () const
	Returns the size of the window used for checking loss.

uint64_t	GetReceived () const
	Returns the number of received packets.

void	SetPacketWindowSize (uint16_t size)
	Set the size of the window used for checking loss.

Public Member Functions inherited from ns3::SinkApplication
	SinkApplication (uint16_t defaultPort=0)
	Constructor.

	~SinkApplication () override

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::SinkApplication
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

Static Public Attributes inherited from ns3::SinkApplication
static constexpr uint32_t	INVALID_PORT {std::numeric_limits<uint32_t>::max()}
	invalid port

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

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
PacketLossCounter	m_lossCounter
	Lost packet counter.

uint64_t	m_received
	Number of received packets.

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.

Ptr< Socket >	m_socket
	Socket.

Ptr< Socket >	m_socket6
	IPv6 Socket (used if only port is specified)

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::SinkApplication
Address	m_local
	Local address to bind to (address and port)

uint32_t	m_port
	Local port to bind to.

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 server, receives UDP packets from a remote host.

UDP packets carry a 32bits sequence number followed by a 64bits time stamp in their payloads. The application uses the sequence number to determine if a packet is lost, and the time stamp to compute the delay.

Config Paths

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

"/NodeList/[i]/ApplicationList/[i]/$ns3::SinkApplication/$ns3::UdpServer"
"/NodeList/[i]/ApplicationList/[i]/$ns3::UdpServer"

Attributes

PacketWindowSize: The size of the window used to compute the packet loss. This value should be a multiple of 8.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 8:256
- Initial value: 32
- Flags: constructwriteread
- Support level: SUPPORTED

Attributes defined in parent class ns3::SinkApplication

Local: The Address on which to Bind the rx socket. If it is not specified, it will listen to any address.
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
Port: Port on which the application listens for incoming packets.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4294967295
- 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

Rx: A packet has been received
- Callback signature: ns3::Packet::TracedCallback
- Support level: SUPPORTED
RxWithAddresses: A packet has been received
- Callback signature: ns3::Packet::TwoAddressTracedCallback
- Support level: SUPPORTED

Group: Applications
Size of this type is 256 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ UdpServer()

ns3::UdpServer::UdpServer ( )

Definition at line 59 of file udp-server.cc.

References ns3::SinkApplication::SinkApplication(), DEFAULT_PORT, m_lossCounter, m_received, m_socket, m_socket6, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~UdpServer()

ns3::UdpServer::~UdpServer ( )

override

Definition at line 69 of file udp-server.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetLost()

uint32_t ns3::UdpServer::GetLost ( ) const

Returns the number of lost packets.

Returns: the number of lost packets

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

References m_lossCounter, and NS_LOG_FUNCTION.

◆ GetPacketWindowSize()

uint16_t ns3::UdpServer::GetPacketWindowSize ( ) const

Returns the size of the window used for checking loss.

Returns: the size of the window used for checking loss.

Definition at line 75 of file udp-server.cc.

References m_lossCounter, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetReceived()

uint64_t ns3::UdpServer::GetReceived ( ) const

Returns the number of received packets.

Returns: the number of received packets

Definition at line 96 of file udp-server.cc.

References m_received, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::UdpServer::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::SinkApplication::SinkApplication(), UdpServer(), GetPacketWindowSize(), m_rxTrace, m_rxTraceWithAddresses, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetPacketWindowSize(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleRead()

void ns3::UdpServer::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 170 of file udp-server.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::SeqTsHeader::GetSeq(), ns3::SeqTsHeader::GetTs(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_lossCounter, m_received, m_rxTrace, m_rxTraceWithAddresses, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPacketWindowSize()

void ns3::UdpServer::SetPacketWindowSize ( uint16_t size )

Set the size of the window used for checking loss.

This value should be a multiple of 8

Parameters

size	the size of the window used for checking loss. This value should be a multiple of 8

Definition at line 82 of file udp-server.cc.

References m_lossCounter, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ StartApplication()

void ns3::UdpServer::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 103 of file udp-server.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::Application::GetNode(), HandleRead(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), ns3::SinkApplication::m_local, ns3::SinkApplication::m_port, m_socket, m_socket6, ns3::MakeCallback(), NS_FATAL_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

Here is the call graph for this function:

◆ StopApplication()

void ns3::UdpServer::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 155 of file udp-server.cc.

References m_socket, m_socket6, ns3::MakeNullCallback(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ DEFAULT_PORT

uint16_t ns3::UdpServer::DEFAULT_PORT {100}

staticconstexpr

default port

Definition at line 40 of file udp-server.h.

Referenced by UdpServer().

◆ m_lossCounter

PacketLossCounter ns3::UdpServer::m_lossCounter

private

Lost packet counter.

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

Referenced by UdpServer(), GetLost(), GetPacketWindowSize(), HandleRead(), and SetPacketWindowSize().

◆ m_received

uint64_t ns3::UdpServer::m_received

private

Number of received packets.

Definition at line 92 of file udp-server.h.

Referenced by UdpServer(), GetReceived(), and HandleRead().

◆ m_rxTrace

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

private

Callbacks for tracing the packet Rx events.

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

Referenced by GetTypeId(), and HandleRead().

◆ m_rxTraceWithAddresses

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

private

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

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

Referenced by GetTypeId(), and HandleRead().

◆ m_socket

Ptr<Socket> ns3::UdpServer::m_socket

private

Socket.

Definition at line 90 of file udp-server.h.

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

◆ m_socket6

Ptr<Socket> ns3::UdpServer::m_socket6

private

IPv6 Socket (used if only port is specified)

Definition at line 91 of file udp-server.h.

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

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

src/applications/model/udp-server.h
src/applications/model/udp-server.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::SinkApplication

Attributes defined in parent class ns3::Application

TraceSources

Constructor & Destructor Documentation

◆ UdpServer()

◆ ~UdpServer()

Member Function Documentation

◆ GetLost()

◆ GetPacketWindowSize()

◆ GetReceived()

◆ GetTypeId()

◆ HandleRead()

◆ SetPacketWindowSize()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ DEFAULT_PORT

◆ m_lossCounter

◆ m_received

◆ m_rxTrace

◆ m_rxTraceWithAddresses

◆ m_socket

◆ m_socket6