A Discrete-Event Network Simulator
API
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::V4PingHelper Class Reference

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

#include "v4ping-helper.h"

Public Member Functions

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

Private Member Functions

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

Private Attributes

ObjectFactory m_factory
 Object factory. More...
 

Detailed Description

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

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

Definition at line 37 of file v4ping-helper.h.

Constructor & Destructor Documentation

◆ V4PingHelper()

ns3::V4PingHelper::V4PingHelper ( Ipv4Address  remote)

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

Parameters
remoteThe address which should be pinged

Definition at line 27 of file v4ping-helper.cc.

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

Member Function Documentation

◆ Install() [1/3]

ApplicationContainer ns3::V4PingHelper::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 V4Ping application.
Returns
A list of Ping applications, one for each input node

Definition at line 53 of file v4ping-helper.cc.

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

Referenced by CsmaPingTestCase::DoRun().

◆ Install() [2/3]

ApplicationContainer ns3::V4PingHelper::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 V4PingApplication on.
Returns
An ApplicationContainer holding the Ping application created.

Definition at line 40 of file v4ping-helper.cc.

References InstallPriv().

◆ Install() [3/3]

ApplicationContainer ns3::V4PingHelper::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 V4PingApplication on.
Returns
An ApplicationContainer holding the Ping application created.

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

References InstallPriv().

◆ InstallPriv()

Ptr< Application > ns3::V4PingHelper::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 65 of file v4ping-helper.cc.

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

Referenced by Install().

◆ SetAttribute()

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

Configure ping applications attribute.

Parameters
nameattribute's name
valueattribute's value

Definition at line 34 of file v4ping-helper.cc.

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

Referenced by AodvExample::InstallApplications().

Member Data Documentation

◆ m_factory

ObjectFactory ns3::V4PingHelper::m_factory
private

Object factory.

Definition at line 93 of file v4ping-helper.h.

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


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