NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ns3::ndn::AppHelper Class Reference

A helper to make it easier to instantiate an ns3::ndn::App applications on a set of nodes. More...

#include <ndn-app-helper.hpp>

Public Member Functions

 AppHelper (const std::string &prefix)
 Create an NdnAppHelper to make it easier to work with Ndn apps. More...
 
void SetPrefix (const std::string &prefix)
 Set the prefix consumer will be requesting. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Helper function used to set the underlying application attributes. More...
 
ApplicationContainer Install (NodeContainer c)
 Install an ns3::NdnConsumer on each node of the input container configured with all the attributes set with SetAttribute. More...
 
ApplicationContainer Install (Ptr< Node > node)
 Install an ns3::NdnConsumer on the node configured with all the attributes set with SetAttribute. More...
 
ApplicationContainer Install (std::string nodeName)
 Install an ns3::NdnConsumer on the node configured with all the attributes set with SetAttribute. More...
 

Detailed Description

A helper to make it easier to instantiate an ns3::ndn::App applications on a set of nodes.

Definition at line 39 of file ndn-app-helper.hpp.

Constructor & Destructor Documentation

◆ AppHelper()

ns3::ndn::AppHelper::AppHelper ( const std::string &  prefix)

Create an NdnAppHelper to make it easier to work with Ndn apps.

Parameters
appClass of the application

Definition at line 37 of file ndn-app-helper.cpp.

Member Function Documentation

◆ SetPrefix()

void ns3::ndn::AppHelper::SetPrefix ( const std::string &  prefix)

Set the prefix consumer will be requesting.

Definition at line 43 of file ndn-app-helper.cpp.

◆ SetAttribute()

void ns3::ndn::AppHelper::SetAttribute ( std::string  name,
const AttributeValue &  value 
)

Helper function used to set the underlying application attributes.

Parameters
namethe name of the application attribute to set
valuethe value of the application attribute to set

Definition at line 49 of file ndn-app-helper.cpp.

Referenced by ns3::ndn::ScenarioHelper::addApps().

◆ Install() [1/3]

ApplicationContainer ns3::ndn::AppHelper::Install ( NodeContainer  c)

Install an ns3::NdnConsumer on each node of the input container configured with all the attributes set with SetAttribute.

Parameters
cNodeContainer of the set of nodes on which an NdnConsumer will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 73 of file ndn-app-helper.cpp.

References ns3::ndn::StackHelper::ProcessWarmupEvents().

Referenced by ns3::ndn::ScenarioHelper::addApps(), and Install().

◆ Install() [2/3]

ApplicationContainer ns3::ndn::AppHelper::Install ( Ptr< Node node)

Install an ns3::NdnConsumer on the node configured with all the attributes set with SetAttribute.

Parameters
nodeThe node on which an NdnConsumer will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 55 of file ndn-app-helper.cpp.

◆ Install() [3/3]

ApplicationContainer ns3::ndn::AppHelper::Install ( std::string  nodeName)

Install an ns3::NdnConsumer on the node configured with all the attributes set with SetAttribute.

Parameters
nodeNameThe node on which an NdnConsumer will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 66 of file ndn-app-helper.cpp.

References Install().


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