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

create a pinger application and associate it to a node More...

#include <v4ping-helper.h>

Public Member Functions

 V4PingHelper (Ipv4Address remote)
 
ApplicationContainer Install (NodeContainer nodes) const
 
ApplicationContainer Install (Ptr< Node > node) const
 
ApplicationContainer Install (std::string nodeName) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 Configure ping applications attribute. More...
 

Private Member Functions

Ptr< ApplicationInstallPriv (Ptr< Node > node) const
 

Private Attributes

ObjectFactory m_factory
 

Detailed Description

create a pinger 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 16 of file v4ping-helper.h.

Constructor & Destructor Documentation

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 ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Member Function Documentation

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

Install a pinger 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 pinger 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().

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

Install a pinger 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 pinger application created.

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

References InstallPriv().

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

Install a pinger 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 pinger application created.

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

References InstallPriv().

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

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

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

Referenced by Install().

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 ns3::ObjectFactory::Set().

Referenced by ns3::aodv::ChainRegressionTest::CreateDevices(), and ns3::olsr::Bug780Test::CreateNodes().


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