A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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...
 
uint32_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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. 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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. 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...
 
uint32_t m_received
 Number of received packets. More...
 
Ptr< Socketm_socket
 IPv4 Socket. More...
 
Ptr< Socketm_socket6
 IPv6 Socket. More...
 

Additional Inherited Members

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

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.
  • PacketWindowSize: The size of the window used to compute the packet loss. This value should be a multiple of 8.

Attributes defined in parent class ns3::Application

  • StartTime: Time at which the application will start
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +0.0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +0.0ns
    • Flags: construct write read

No TraceSources are defined for this type.

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.

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

Constructor & Destructor Documentation

ns3::UdpServer::UdpServer ( )

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

References m_received, and NS_LOG_FUNCTION.

ns3::UdpServer::~UdpServer ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::UdpServer::DoDispose ( void  )
protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 105 of file udp-server.cc.

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

+ Here is the call graph for this function:

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

Returns the number of lost packets.

Returns
the number of lost packets

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

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

+ Here is the call graph for this function:

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

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

Returns the number of received packets.

Returns
the number of received packets

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

References m_received, and NS_LOG_FUNCTION.

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

Get the type ID.

Returns
the object TypeId

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

References GetPacketWindowSize(), m_port, 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:

void ns3::UdpServer::HandleRead ( Ptr< Socket socket)
private
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 84 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:

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 112 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_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

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

PacketLossCounter ns3::UdpServer::m_lossCounter
private

Lost packet counter.

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

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

uint16_t ns3::UdpServer::m_port
private

Port on which we listen for incoming packets.

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

Referenced by GetTypeId(), and StartApplication().

uint32_t ns3::UdpServer::m_received
private

Number of received packets.

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

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

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

IPv4 Socket.

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

Referenced by StartApplication(), and StopApplication().

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

IPv6 Socket.

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

Referenced by StartApplication().


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