A Udp Echo server. More...

#include "udp-echo-server.h"

Inheritance diagram for ns3::UdpEchoServer:

Collaboration diagram for ns3::UdpEchoServer:

Public Member Functions
	UdpEchoServer ()
	~UdpEchoServer () override
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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.
template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.
template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) 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.
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.
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 {9}
	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	DoStartApplication () override
	Application specific startup code for child subclasses.
void	HandleRead (Ptr< Socket > socket)
	Handle a packet reception.

Private Attributes
TracedCallback< Ptr< const Packet >, const Address &, const Address & >	m_rxTraceWithAddresses
	Callbacks for tracing the packet Rx events, includes source and destination addresses.
uint8_t	m_tos
	The packets Type of Service.

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::SinkApplication
bool	CloseAllSockets ()
	Close all the sockets.
void	DoDispose () override
	Destructor implementation.
Protected Member Functions inherited from ns3::Application
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.
TypeId	m_protocolTid
	Protocol TypeId value.
TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
	Traced Callback: received packets, source address.
ns3::TracedCallback< Ptr< const Packet > >	m_rxTraceWithoutAddress
	Callbacks for tracing the packet Rx events.
Ptr< Socket >	m_socket
	Socket (IPv4 or IPv6, depending on local address).
Ptr< Socket >	m_socket6
	IPv6 Socket (used if only port is specified).
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 Echo server.

Every packet received is sent back.

Config Paths

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

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

Attributes

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

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

TraceSources defined in parent class ns3::SinkApplication

Rx: A packet has been received
- Callback signature: ns3::Packet::AddressTracedCallback
- Support level: SUPPORTED
RxWithoutAddress: A packet has been received from a given address
- Callback signature: ns3::Packet::TracedCallback
- Support level: SUPPORTED

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

Definition at line 32 of file udp-echo-server.h.

Constructor & Destructor Documentation

◆ UdpEchoServer()

ns3::UdpEchoServer::UdpEchoServer ( )

Definition at line 51 of file udp-echo-server.cc.

References ns3::SinkApplication::SinkApplication(), DEFAULT_PORT, ns3::TypeId::LookupByName(), ns3::SinkApplication::m_protocolTid, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~UdpEchoServer()

ns3::UdpEchoServer::~UdpEchoServer ( )

override

Definition at line 58 of file udp-echo-server.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoStartApplication()

void ns3::UdpEchoServer::DoStartApplication ( )

overrideprivatevirtual

Application specific startup code for child subclasses.

Reimplemented from ns3::SinkApplication.

Definition at line 64 of file udp-echo-server.cc.

References ns3::DynamicCast(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), HandleRead(), ns3::addressUtils::IsMulticast(), ns3::SinkApplication::m_local, ns3::SinkApplication::m_port, ns3::SinkApplication::m_socket, ns3::SinkApplication::m_socket6, m_tos, ns3::MakeCallback(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UdpEchoServer::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 31 of file udp-echo-server.cc.

References ns3::SinkApplication::SinkApplication(), UdpEchoServer(), m_rxTraceWithAddresses, m_tos, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleRead()

void ns3::UdpEchoServer::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 118 of file udp-echo-server.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::SinkApplication::m_rxTrace, m_rxTraceWithAddresses, ns3::SinkApplication::m_rxTraceWithoutAddress, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and ns3::Time::S.

Referenced by DoStartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_PORT

uint16_t ns3::UdpEchoServer::DEFAULT_PORT {9}

staticconstexpr

default port

Definition at line 35 of file udp-echo-server.h.

Referenced by UdpEchoServer().

◆ m_rxTraceWithAddresses

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

private

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

Definition at line 61 of file udp-echo-server.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_tos

uint8_t ns3::UdpEchoServer::m_tos

private

The packets Type of Service.

Definition at line 58 of file udp-echo-server.h.

Referenced by DoStartApplication(), and GetTypeId().

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

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

TraceSources defined in parent class ns3::SinkApplication

Constructor & Destructor Documentation

◆ UdpEchoServer()

◆ ~UdpEchoServer()

Member Function Documentation

◆ DoStartApplication()

◆ GetTypeId()

◆ HandleRead()

Member Data Documentation

◆ DEFAULT_PORT

◆ m_rxTraceWithAddresses

◆ m_tos