A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::V4Ping Class Reference

an application which sends one ICMP ECHO request, waits for a REPLYs and reports the calculated RTT. More...

#include <v4ping.h>

+ Inheritance diagram for ns3::V4Ping:

Public Member Functions

 V4Ping ()
 
- Public Member Functions inherited from ns3::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
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 (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
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)
 

Private Member Functions

virtual void DoDispose (void)
 
uint32_t GetApplicationId (void) const
 
void Read32 (const uint8_t *buffer, uint32_t &data)
 
void Receive (Ptr< Socket > socket)
 
void Send ()
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 
void Write32 (uint8_t *buffer, const uint32_t data)
 

Private Attributes

Average< double > m_avgRtt
 Average rtt is ms.
 
Time m_interval
 Wait interval seconds between sending each packet.
 
EventId m_next
 Next packet will be sent.
 
uint32_t m_recv
 received packets counter
 
Ipv4Address m_remote
 Remote address.
 
std::map< uint16_t, Timem_sent
 All sent but not answered packets. Map icmp seqno -> when sent.
 
uint16_t m_seq
 
uint32_t m_size
 
Ptr< Socketm_socket
 
Time m_started
 Start time to report total ping time.
 
TracedCallback< Timem_traceRtt
 
bool m_verbose
 produce ping-style output if true
 

Additional Inherited Members

- 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)
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 
EventId m_startEvent
 
Time m_startTime
 
EventId m_stopEvent
 
Time m_stopTime
 

Detailed Description

an application which sends one ICMP ECHO request, waits for a REPLYs and reports the calculated RTT.

Note: The RTT calculated is reported through a trace source.

Config Paths

ns3::V4Ping is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes

  • Remote: The address of the machine we want to ping.
  • Verbose: Produce usual output.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • Interval: Wait interval seconds between sending each packet.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • Size: The number of data bytes to be sent, real packet will be 8 (ICMP) + 20 (IP) bytes longer.

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

TraceSources

  • Rtt: The rtt calculated by the ping.

Definition at line 36 of file v4ping.h.

Constructor & Destructor Documentation

ns3::V4Ping::V4Ping ( )

create a pinger applications

Definition at line 64 of file v4ping.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::V4Ping::DoDispose ( void  )
privatevirtual

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 80 of file v4ping.cc.

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

void ns3::V4Ping::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 232 of file v4ping.cc.

References ns3::Socket::Bind(), ns3::Socket::Connect(), ns3::Socket::CreateSocket(), ns3::Ipv4Address::GetAny(), ns3::Application::GetNode(), ns3::TypeId::LookupByName(), m_remote, m_started, m_verbose, ns3::MakeCallback(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, ns3::ObjectBase::SetAttribute(), and ns3::Socket::SetRecvCallback().

void ns3::V4Ping::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 257 of file v4ping.cc.

References ns3::Average< T >::Avg(), ns3::EventId::Cancel(), ns3::Socket::Close(), ns3::Average< T >::Count(), m_avgRtt, m_next, m_recv, m_remote, m_started, m_verbose, ns3::Average< T >::Max(), ns3::Average< T >::Min(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::Average< T >::Stddev().

Member Data Documentation

uint32_t ns3::V4Ping::m_size
private

Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.

Definition at line 67 of file v4ping.h.


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