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

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 ()
 
virtual ~UdpServer ()
 
uint32_t GetLost (void) const
 Returns the number of lost packets. More...
 
uint16_t GetPacketWindowSize () const
 Returns the size of the window used for checking loss. More...
 
uint64_t GetReceived (void) const
 Returns the number of received packets. More...
 
void SetPacketWindowSize (uint16_t size)
 Set the size of the window used for checking loss. More...
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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 () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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...
 
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 DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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

PacketLossCounter m_lossCounter
 Lost packet counter. More...
 
uint16_t m_port
 Port on which we listen for incoming packets. More...
 
uint64_t m_received
 Number of received 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 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::UdpServer"

Attributes

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

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: construct write read
  • 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: construct write read

TraceSources

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

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

Constructor & Destructor Documentation

◆ UdpServer()

ns3::UdpServer::UdpServer ( )

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

References m_received, and NS_LOG_FUNCTION.

◆ ~UdpServer()

ns3::UdpServer::~UdpServer ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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

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

+ Here is the call graph for this function:

◆ GetLost()

uint32_t ns3::UdpServer::GetLost ( void  ) const

Returns the number of lost packets.

Returns
the number of lost packets

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

References ns3::PacketLossCounter::GetLost(), m_lossCounter, and NS_LOG_FUNCTION.

+ Here is the call graph for this 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 85 of file udp-server.cc.

References ns3::PacketLossCounter::GetBitMapSize(), m_lossCounter, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

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

◆ GetReceived()

uint64_t ns3::UdpServer::GetReceived ( void  ) const

Returns the number of received packets.

Returns
the number of received packets

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

References m_received, and NS_LOG_FUNCTION.

Referenced by Issue211Test::CalcThroughput().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

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

Referenced by ns3::UdpServerHelper::UdpServerHelper().

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

◆ HandleRead()

void ns3::UdpServer::HandleRead ( Ptr< Socket socket)
private

◆ 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
sizethe size of the window used for checking loss. This value should be a multiple of 8

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

References m_lossCounter, NS_LOG_FUNCTION, and ns3::PacketLossCounter::SetBitMapSize().

Referenced by GetTypeId().

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

◆ StartApplication()

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

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), ns3::Application::GetNode(), HandleRead(), ns3::TypeId::LookupByName(), 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::UdpServer::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 155 of file udp-server.cc.

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_lossCounter

PacketLossCounter ns3::UdpServer::m_lossCounter
private

Lost packet counter.

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

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

◆ m_port

uint16_t ns3::UdpServer::m_port
private

Port on which we listen for incoming packets.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_received

uint64_t ns3::UdpServer::m_received
private

Number of received packets.

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

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

◆ m_rxTrace

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

Callbacks for tracing the packet Rx events.

Definition at line 107 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 110 of file udp-server.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_socket

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

IPv4 Socket.

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

Referenced by StartApplication(), and StopApplication().

◆ m_socket6

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

IPv6 Socket.

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

Referenced by StartApplication().


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