A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::PingHelper Class Reference

Create a ping application and associate it to a node. More...

#include "ping-helper.h"

+ Collaboration diagram for ns3::PingHelper:

Public Member Functions

 PingHelper ()
 Create a PingHelper which is used to make life easier for people wanting to use ping Applications.
 
 PingHelper (Address remote, Address local=Address())
 Create a PingHelper which is used to make life easier for people wanting to use ping Applications.
 
ApplicationContainer Install (NodeContainer nodes) const
 Install a Ping application on each Node in the provided NodeContainer.
 
ApplicationContainer Install (Ptr< Node > node) const
 Install a Ping application on the provided Node.
 
ApplicationContainer Install (std::string nodeName) const
 Install a Ping application on the provided Node.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Configure ping applications attribute.
 

Private Member Functions

Ptr< ApplicationInstallPriv (Ptr< Node > node) const
 Do the actual application installation in the node.
 

Private Attributes

ObjectFactory m_factory
 Object factory.
 

Detailed Description

Create a ping application and associate it to a node.

This class creates one or multiple instances of ns3::Ping and associates it/them to one/multiple node(s).

Definition at line 47 of file ping-helper.h.

Constructor & Destructor Documentation

◆ PingHelper() [1/2]

ns3::PingHelper::PingHelper ( )

Create a PingHelper which is used to make life easier for people wanting to use ping Applications.

Definition at line 33 of file ping-helper.cc.

References m_factory, and ns3::ObjectFactory::SetTypeId().

+ Here is the call graph for this function:

◆ PingHelper() [2/2]

ns3::PingHelper::PingHelper ( Address  remote,
Address  local = Address() 
)

Create a PingHelper which is used to make life easier for people wanting to use ping Applications.

Parameters
remoteThe address which should be pinged
localThe source address

Definition at line 38 of file ping-helper.cc.

References m_factory, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

+ Here is the call graph for this function:

Member Function Documentation

◆ Install() [1/3]

ApplicationContainer ns3::PingHelper::Install ( NodeContainer  nodes) const

Install a Ping application on each Node in the provided NodeContainer.

Parameters
nodesThe NodeContainer containing all of the nodes to get a Ping application.
Returns
A list of Ping applications, one for each input node

Definition at line 65 of file ping-helper.cc.

References ns3::ApplicationContainer::Add(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and InstallPriv().

Referenced by CsmaPingTestCase::DoRun(), and AodvExample::InstallApplications().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Install() [2/3]

ApplicationContainer ns3::PingHelper::Install ( Ptr< Node node) const

Install a Ping application on the provided Node.

The Node is specified directly by a Ptr<Node>

Parameters
nodeThe node to install the Ping application on.
Returns
An ApplicationContainer holding the Ping application created.

Definition at line 52 of file ping-helper.cc.

References InstallPriv().

+ Here is the call graph for this function:

◆ Install() [3/3]

ApplicationContainer ns3::PingHelper::Install ( std::string  nodeName) const

Install a Ping application on the provided Node.

The Node is specified by a string that must have previously been associated with a Node using the Object Name Service.

Parameters
nodeNameThe node to install the Ping application on.
Returns
An ApplicationContainer holding the Ping application created.

Definition at line 58 of file ping-helper.cc.

References InstallPriv().

+ Here is the call graph for this function:

◆ InstallPriv()

Ptr< Application > ns3::PingHelper::InstallPriv ( Ptr< Node node) const
private

Do the actual application installation in the node.

Parameters
nodethe node
Returns
a Smart pointer to the installed application

Definition at line 77 of file ping-helper.cc.

References ns3::ObjectFactory::Create(), and m_factory.

Referenced by Install().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetAttribute()

void ns3::PingHelper::SetAttribute ( std::string  name,
const AttributeValue value 
)

Configure ping applications attribute.

Parameters
nameattribute's name
valueattribute's value

Definition at line 46 of file ping-helper.cc.

References m_factory, and ns3::ObjectFactory::Set().

Referenced by AodvExample::InstallApplications().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_factory

ObjectFactory ns3::PingHelper::m_factory
private

Object factory.

Definition at line 111 of file ping-helper.h.

Referenced by PingHelper(), InstallPriv(), and SetAttribute().


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