A Discrete-Event Network Simulator
API
ns3::UdpEchoServer Class Reference

A Udp Echo server. More...

#include "udp-echo-server.h"

+ Inheritance diagram for ns3::UdpEchoServer:
+ Collaboration diagram for ns3::UdpEchoServer:

Public Member Functions

 UdpEchoServer ()
 
virtual ~UdpEchoServer ()
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void HandleRead (Ptr< Socket > socket)
 Handle a packet reception. More...
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

Address m_local
 local multicast address More...
 
uint16_t m_port
 Port on which we listen for incoming packets. More...
 
TracedCallback< Ptr< const Packet > > m_rxTrace
 Callbacks for tracing the packet Rx events. More...
 
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
 Callbacks for tracing the packet Rx events, includes source and destination addresses. More...
 
Ptr< Socketm_socket
 IPv4 Socket. More...
 
Ptr< Socketm_socket6
 IPv6 Socket. More...
 

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. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

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

Attributes

  • Port: Port on which we listen for incoming packets.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint16_t 0:65535
    • Initial value: 9
    • 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

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

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

Constructor & Destructor Documentation

◆ UdpEchoServer()

ns3::UdpEchoServer::UdpEchoServer ( )

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

References NS_LOG_FUNCTION.

◆ ~UdpEchoServer()

ns3::UdpEchoServer::~UdpEchoServer ( )
virtual

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

References m_socket, m_socket6, and NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::UdpEchoServer::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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.

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

References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UdpEchoServer::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References m_port, m_rxTrace, m_rxTraceWithAddresses, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Referenced by ns3::UdpEchoServerHelper::UdpEchoServerHelper().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ HandleRead()

◆ StartApplication()

void ns3::UdpEchoServer::StartApplication ( void  )
privatevirtual

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 82 of file udp-echo-server.cc.

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Ipv6Address::GetAny(), ns3::Ipv4Address::GetAny(), ns3::Application::GetNode(), HandleRead(), ns3::addressUtils::IsMulticast(), ns3::TypeId::LookupByName(), m_local, m_port, m_socket, m_socket6, ns3::MakeCallback(), NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ StopApplication()

void ns3::UdpEchoServer::StopApplication ( void  )
privatevirtual

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 139 of file udp-echo-server.cc.

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_local

Address ns3::UdpEchoServer::m_local
private

local multicast address

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

Referenced by StartApplication().

◆ m_port

uint16_t ns3::UdpEchoServer::m_port
private

Port on which we listen for incoming packets.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_rxTrace

TracedCallback<Ptr<const Packet> > ns3::UdpEchoServer::m_rxTrace
private

Callbacks for tracing the packet Rx events.

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

Referenced by GetTypeId(), and HandleRead().

◆ 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 81 of file udp-echo-server.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_socket

Ptr<Socket> ns3::UdpEchoServer::m_socket
private

IPv4 Socket.

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

Referenced by ~UdpEchoServer(), StartApplication(), and StopApplication().

◆ m_socket6

Ptr<Socket> ns3::UdpEchoServer::m_socket6
private

IPv6 Socket.

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

Referenced by ~UdpEchoServer(), StartApplication(), and StopApplication().


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