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

List of all members.

Public Member Functions

uint32_t GetLost (void) const
uint32_t GetReceived (void) const
 returns the number of received packets
uint16_t GetPacketWindowSize () const
void SetPacketWindowSize (uint16_t size)
 Set the size of the window used for checking loss. This value should be a multiple of 8.
- Public Member Functions inherited from ns3::Application
void SetStartTime (Time start)
 Specify application start time.
void SetStopTime (Time stop)
 Specify application stop time.
Ptr< NodeGetNode () const
void SetNode (Ptr< Node > node)
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::UdpServer.

Protected Member Functions

virtual void DoDispose (void)
- Protected Member Functions inherited from ns3::Application
virtual void DoStart (void)
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
 Object (const Object &o)

Additional Inherited Members

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

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.


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.

References NS_LOG_FUNCTION.

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

returns the number of lost packets

Returns:
the number of lost packets
uint16_t ns3::UdpServer::GetPacketWindowSize ( ) const
Returns:
the size of the window used for checking loss.

Referenced by GetTypeId().

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

returns the number of received packets

Returns:
the number of received packets
TypeId ns3::UdpServer::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::UdpServer.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/ApplicationList/[i]/$ns3::UdpServer

Attributes defined for this type:

  • 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: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Application.

References GetPacketWindowSize(), SetPacketWindowSize(), and ns3::TypeId::SetParent().

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

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

Referenced by GetTypeId().


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