System configuration file for NDN platform. More...

#include <config-file.hpp>

Inheritance diagram for ndn::ConfigFile:

Collaboration diagram for ndn::ConfigFile:

Classes
class	Error

Public Types
using	Parsed = boost::property_tree::ptree

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

◆ Parsed

using ndn::ConfigFile::Parsed = boost::property_tree::ptree

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

Constructor & Destructor Documentation

◆ ConfigFile()

ndn::ConfigFile::ConfigFile ( )

Locate, open, and parse a library configuration file.

Exceptions

ConfigFile::Error on parse error

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

◆ ~ConfigFile()

ndn::ConfigFile::~ConfigFile ( )

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

References NDN_THROW, and ndn::to_string().

Member Function Documentation

◆ getPath()

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

inline

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

◆ getParsedConfiguration()

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

inline

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

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

ndnSIM/ndn-cxx/ndn-cxx/util/config-file.hpp
ndnSIM/ndn-cxx/ndn-cxx/util/config-file.cpp

Classes

Public Types

Public Member Functions