A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::UdpEchoServer Class Reference
UdpEcho

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< Node > GetNode () const
void SetNode (Ptr< Node > node)
void SetStartTime (Time start)
 Specify application start time.
void SetStopTime (Time stop)
 Specify application stop time.
- 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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (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)
 This method returns the TypeId associated to ns3::UdpEchoServer.

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
 Object (const Object &o)
virtual void NotifyNewAggregate (void)

Private Member Functions

void HandleRead (Ptr< Socket > socket)
virtual void StartApplication (void)
virtual void StopApplication (void)

Private Attributes

Address m_local
uint16_t m_port
Ptr< Socket > m_socket
Ptr< Socket > m_socket6

Additional Inherited Members

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

Detailed Description

A Udp Echo server.

Every packet received is sent back.

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

Constructor & Destructor Documentation

ns3::UdpEchoServer::UdpEchoServer ( )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::UdpEchoServer::~UdpEchoServer ( )
virtual

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

References m_socket, m_socket6, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::UdpEchoServer::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 67 of file udp-echo-server.cc.

References NS_LOG_FUNCTION_NOARGS.

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

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

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

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

Attributes defined for this type:

  • Port: Port on which we listen for incoming packets.

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.

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

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

void ns3::UdpEchoServer::HandleRead ( Ptr< Socket >  socket)
private

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Packet::GetSize(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::Simulator::Now(), NS_LOG_INFO, NS_LOG_LOGIC, ns3::Socket::RecvFrom(), ns3::Packet::RemoveAllByteTags(), ns3::Packet::RemoveAllPacketTags(), and ns3::Socket::SendTo().

Referenced by StartApplication().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::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_NOARGS, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

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

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

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

+ Here is the call graph for this function:

Member Data Documentation

Address ns3::UdpEchoServer::m_local
private

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

Referenced by StartApplication().

uint16_t ns3::UdpEchoServer::m_port
private

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

Referenced by GetTypeId(), and StartApplication().

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

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

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

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

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

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

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