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. 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. 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
 
uint16_t GetPacketWindowSize () const
 
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. This value should be a multiple of 8. 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)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
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)
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Member Functions

virtual void DoDispose (void)
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Private Member Functions

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

Private Attributes

Address m_local
 
PacketLossCounter m_lossCounter
 
uint16_t m_port
 
uint32_t m_received
 
Ptr< Socketm_socket
 
Ptr< Socketm_socket6
 

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 
EventId m_startEvent
 
Time m_startTime
 
EventId m_stopEvent
 
Time m_stopTime
 

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

Definition at line 45 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.

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

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

Address ns3::UdpServer::m_local
private

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

PacketLossCounter ns3::UdpServer::m_lossCounter
private

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

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

uint16_t ns3::UdpServer::m_port
private

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

Referenced by GetTypeId(), and StartApplication().

uint32_t ns3::UdpServer::m_received
private

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

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

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

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

Referenced by StartApplication(), and StopApplication().

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

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

Referenced by StartApplication().


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