NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Types | Public Member Functions | List of all members
ndn::ConfigFile Class Reference

System configuration file for NDN platform. More...

#include <config-file.hpp>

Inheritance diagram for ndn::ConfigFile:
Inheritance graph
[legend]
Collaboration diagram for ndn::ConfigFile:
Collaboration graph
[legend]

Classes

class  Error
 

Public Types

typedef boost::property_tree::ptree Parsed
 

Public Member Functions

 ConfigFile ()
 Locate, open, and parse a library configuration file. More...
 
 ~ConfigFile ()
 
const boost::filesystem::path & getPath () const
 
const Parsed & getParsedConfiguration () const
 

Detailed Description

System configuration file for NDN platform.

The config file controls the default transport to connect to NDN forwarder, type and location of PIB and TPM.

Looking for the configuration file in these well-known locations (in order):

  • $HOME/.ndn/client.conf
  • @SYSCONFDIR@/ndn/client.conf
  • /etc/ndn/client.conf
See also
Manpage of ndn-client.conf

Definition at line 48 of file config-file.hpp.

Member Typedef Documentation

typedef boost::property_tree::ptree ndn::ConfigFile::Parsed

Definition at line 62 of file config-file.hpp.

Constructor & Destructor Documentation

ndn::ConfigFile::ConfigFile ( )

Locate, open, and parse a library configuration file.

Exceptions
ConfigFile::Erroron parse error

Definition at line 29 of file config-file.cpp.

ndn::ConfigFile::~ConfigFile ( )

Definition at line 39 of file config-file.cpp.

Member Function Documentation

const boost::filesystem::path & ndn::ConfigFile::getPath ( ) const
inline

Definition at line 122 of file config-file.hpp.

const ConfigFile::Parsed & ndn::ConfigFile::getParsedConfiguration ( ) const
inline

Definition at line 128 of file config-file.hpp.

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