NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd Namespace Reference

Copyright (c) 2011-2015 Regents of the University of California. More...

Namespaces

 cs
 
 detail
 
 ethernet
 
 face
 
 fib
 
 fw
 
 general
 
 measurements
 
 name_tree
 
 pit
 
 rib
 
 scheduler
 
 scope_prefix
 contain name prefixes that affect namespace-based scope control
 
 strategy_choice
 
 tcp
 
 tlv
 
 udp
 
 unix_stream
 
 websocket
 

Classes

class  ByteCounter
 represents a counter of number of bytes More...
 
class  CommandAuthenticator
 provides ControlCommand authorization according to NFD configuration file More...
 
class  CommandAuthenticatorValidationPolicy
 a validation policy that only permits Interest signed by a trust anchor More...
 
class  ConfigFile
 configuration file parsing utility More...
 
class  CsManager
 Implement the CS Management of NFD Management Protocol. More...
 
class  DeadNonceList
 represents the Dead Nonce list More...
 
class  FaceManager
 implement the Face Management of NFD Management Protocol. More...
 
class  FaceTable
 container of all faces More...
 
class  FibManager
 implement the FIB Management of NFD Management Protocol. More...
 
class  Forwarder
 main class of NFD More...
 
class  ForwarderCounters
 counters provided by Forwarder More...
 
class  ForwarderStatusManager
 implement the Forwarder Status of NFD Management Protocol. More...
 
class  IpAddressPredicate
 Represents a predicate to accept or reject an IP address. More...
 
class  ManagerBase
 a collection of common functions shared by all NFD managers and RIB manager, such as communicating with the dispatcher and command validator. More...
 
class  Network
 
class  NetworkInterfacePredicate
 Represents a predicate to accept or reject a ndn::net::NetworkInterface. More...
 
class  NetworkPredicateBase
 
class  NetworkRegionTable
 stores a collection of producer region names More...
 
class  Nfd
 Class representing NFD instance This class can be used to initialize all components of NFD. More...
 
class  NfdManagerBase
 a collection of common functions shared by all NFD managers, such as communicating with the dispatcher and command validator. More...
 
class  NfdRunner
 Executes NFD with RIB manager. More...
 
class  PacketCounter
 represents a counter of number of packets More...
 
class  PrivilegeHelper
 
class  RttEstimator
 implements the Mean-Deviation RTT estimator More...
 
class  SimpleCounter
 represents a counter that encloses an integer value More...
 
class  SizeCounter
 provides a counter that observes the size of a table More...
 
class  StrategyChoiceManager
 implement the Strategy Choice Management of NFD Management Protocol. More...
 
class  StrategyInfoHost
 base class for an entity onto which StrategyInfo items may be placed More...
 
class  TablesConfigSection
 handles 'tables' config section More...
 

Typedefs

using ConfigSection = boost::property_tree::ptree
 a config file section More...
 
using OptionalConfigSection = boost::optional< const ConfigSection & >
 an optional config file section More...
 
using ConfigSectionHandler = std::function< void(const ConfigSection &section, bool isDryRun, const std::string &filename)>
 callback to process a config file section More...
 
using UnknownConfigSectionHandler = std::function< void(const std::string &filename, const std::string &sectionName, const ConfigSection &section, bool isDryRun)>
 callback to process a config file section without a ConfigSectionHandler More...
 
using SignerTag = ndn::SimpleTag< Name, 20 >
 an Interest tag to indicate command signer More...
 

Functions

It find_last_if (It first, It last, Pred p)
 
template<typename E >
std::string getExtendedErrorMessage (const E &exception)
 
detail::SimulatorIogetGlobalIoService ()
 
static bool doesMatchPattern (const std::string &ifname, const std::string &pattern)
 
static bool doesNetifMatchRule (const ndn::net::NetworkInterface &netif, const std::string &rule)
 
static bool doesAddressMatchRule (const boost::asio::ip::address &address, const std::string &rule)
 
std::ostream & operator<< (std::ostream &os, const Network &network)
 
std::istream & operator>> (std::istream &is, Network &network)
 
std::mt19937 & getGlobalRng ()
 
 NDN_CXX_ASSERT_FORWARD_ITERATOR (FaceTable::const_iterator)
 
static Name getDefaultStrategyName ()
 
static bool compare_InRecord_expiry (const pit::InRecord &a, const pit::InRecord &b)
 
static void insertNonceToDnl (DeadNonceList &dnl, const pit::Entry &pitEntry, const pit::OutRecord &outRecord)
 
static void printUsage (std::ostream &os, const char *programName, const po::options_description &opts)
 
static void printLogModules (std::ostream &os)
 
static optional< std::string > getSignerFromTag (const Interest &interest)
 obtain signer from SignerTag attached to Interest, if available More...
 
static const time::milliseconds STATUS_FRESHNESS (5000)
 
static void ignoreRibAndLogSections (const std::string &filename, const std::string &sectionName, const ConfigSection &section, bool isDryRun)
 
void cleanupOnFaceRemoval (NameTree &nt, Fib &fib, Pit &pit, const Face &face)
 cleanup tables when a face is destroyed More...
 

Variables

static const int FIB_MAX_DEPTH = 32
 Maximum number of components in a FIB entry prefix. More...
 
 PrivilegeHelper
 
 FaceTable
 
 Forwarder
 
 CommandAuthenticator
 
 FaceManager
 
 FibManager
 
 StrategyChoiceManager
 
 Nfd
 
static const std::string INTERNAL_CONFIG = "internal://nfd.conf"
 

Detailed Description

Copyright (c) 2011-2015 Regents of the University of California.

Copyright (c) 2014, Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

Copyright (c) 2014 Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

Copyright (c) 2014-2016, Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

Copyright (c) 2014-2017, Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and contributors.

ndnSIM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ndnSIM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ndnSIM, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

Louis, Beijing Institute of Technology, The University of Memphis.

This file is part of NFD (Named Data Networking Forwarding Daemon). See AUTHORS.md for complete list of NFD authors and contributors.

NFD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with NFD, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

Louis, Beijing Institute of Technology

This file is part of NFD (Named Data Networking Forwarding Daemon). See AUTHORS.md for complete list of NFD authors and contributors.

NFD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with NFD, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

Louis, Beijing Institute of Technology, The University of Memphis

This file is part of NFD (Named Data Networking Forwarding Daemon). See AUTHORS.md for complete list of NFD authors and contributors.

NFD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with NFD, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

Typedef Documentation

◆ ConfigSection

typedef boost::property_tree::ptree nfd::ConfigSection

a config file section

Definition at line 38 of file ndn-l3-protocol.hpp.

◆ OptionalConfigSection

using nfd::OptionalConfigSection = typedef boost::optional<const ConfigSection&>

an optional config file section

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

◆ ConfigSectionHandler

using nfd::ConfigSectionHandler = typedef std::function<void(const ConfigSection& section, bool isDryRun, const std::string& filename)>

callback to process a config file section

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

◆ UnknownConfigSectionHandler

using nfd::UnknownConfigSectionHandler = typedef std::function<void(const std::string& filename, const std::string& sectionName, const ConfigSection& section, bool isDryRun)>

callback to process a config file section without a ConfigSectionHandler

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

◆ SignerTag

using nfd::SignerTag = typedef ndn::SimpleTag<Name, 20>

an Interest tag to indicate command signer

Definition at line 50 of file command-authenticator.cpp.

Function Documentation

◆ find_last_if()

It nfd::find_last_if ( It  first,
It  last,
Pred  p 
)

Definition at line 49 of file algorithm.hpp.

◆ getExtendedErrorMessage()

template<typename E >
std::string nfd::getExtendedErrorMessage ( const E &  exception)

Definition at line 36 of file extended-error-message.hpp.

Referenced by main(), and nfd::NfdRunner::run().

◆ getGlobalIoService()

◆ doesMatchPattern()

static bool nfd::doesMatchPattern ( const std::string &  ifname,
const std::string &  pattern 
)
static

Definition at line 168 of file network-predicate.cpp.

Referenced by doesNetifMatchRule().

◆ doesNetifMatchRule()

◆ doesAddressMatchRule()

static bool nfd::doesAddressMatchRule ( const boost::asio::ip::address &  address,
const std::string &  rule 
)
static

Definition at line 201 of file network-predicate.cpp.

References nfd::Network::doesContain().

Referenced by nfd::IpAddressPredicate::operator()().

◆ operator<<()

std::ostream & nfd::operator<< ( std::ostream &  os,
const Network network 
)

Definition at line 80 of file network.cpp.

◆ operator>>()

std::istream & nfd::operator>> ( std::istream &  is,
Network network 
)

Definition at line 86 of file network.cpp.

References ndn::ip::addressFromString().

◆ getGlobalRng()

std::mt19937 & nfd::getGlobalRng ( )
Returns
the global random number generator instance

Definition at line 32 of file random.cpp.

Referenced by nfd::fw::NccStrategy::doPropagate(), and nfd::rib::randomizeTimer().

◆ NDN_CXX_ASSERT_FORWARD_ITERATOR()

nfd::NDN_CXX_ASSERT_FORWARD_ITERATOR ( FaceTable::const_iterator  )

◆ getDefaultStrategyName()

static Name nfd::getDefaultStrategyName ( )
static

Definition at line 41 of file forwarder.cpp.

References nfd::fw::BestRouteStrategy2::getStrategyName().

Referenced by nfd::Forwarder::Forwarder().

◆ compare_InRecord_expiry()

static bool nfd::compare_InRecord_expiry ( const pit::InRecord a,
const pit::InRecord b 
)
inlinestatic

Definition at line 180 of file forwarder.cpp.

References nfd::pit::FaceRecord::getExpiry().

◆ insertNonceToDnl()

static void nfd::insertNonceToDnl ( DeadNonceList dnl,
const pit::Entry pitEntry,
const pit::OutRecord outRecord 
)
inlinestatic

◆ printUsage()

static void nfd::printUsage ( std::ostream &  os,
const char *  programName,
const po::options_description &  opts 
)
static

Definition at line 208 of file main.cpp.

Referenced by main().

◆ printLogModules()

static void nfd::printLogModules ( std::ostream &  os)
static

Definition at line 218 of file main.cpp.

Referenced by main().

◆ getSignerFromTag()

static optional<std::string> nfd::getSignerFromTag ( const Interest interest)
static

obtain signer from SignerTag attached to Interest, if available

Definition at line 55 of file command-authenticator.cpp.

References ndn::SimpleTag< T, TypeId >::get(), ndn::TagHost::getTag(), and ndn::nullopt.

Referenced by nfd::CommandAuthenticator::makeAuthorization().

◆ STATUS_FRESHNESS()

static const time::milliseconds nfd::STATUS_FRESHNESS ( 5000  )
static

◆ ignoreRibAndLogSections()

static void nfd::ignoreRibAndLogSections ( const std::string &  filename,
const std::string &  sectionName,
const ConfigSection section,
bool  isDryRun 
)
inlinestatic

Definition at line 117 of file nfd.cpp.

References nfd::ConfigFile::throwErrorOnUnknownSection().

Referenced by nfd::Nfd::reloadConfigFile().

◆ cleanupOnFaceRemoval()

void nfd::cleanupOnFaceRemoval ( NameTree nt,
Fib fib,
Pit pit,
const Face face 
)

cleanup tables when a face is destroyed

This function enumerates the NameTree, calls Fib::removeNextHop for each FIB entry, calls Pit::deleteInOutRecords for each PIT entry, and finally deletes any name tree entries that have become empty.

Note
It's a design choice to let Fib and Pit classes decide what to do with each entry. This function is only responsible for implementing the enumeration procedure. The benefit of having this function instead of doing the enumeration in Fib and Pit classes is to perform both FIB and PIT cleanups in one pass of NameTree enumeration, so as to reduce performance overhead.

Definition at line 31 of file cleanup.cpp.

References nfd::pit::Pit::deleteInOutRecords(), and nfd::fib::Fib::removeNextHop().

Referenced by nfd::Forwarder::Forwarder().

Variable Documentation

◆ FIB_MAX_DEPTH

const int nfd::FIB_MAX_DEPTH = 32
static

Maximum number of components in a FIB entry prefix.

Definition at line 33 of file fib-max-depth.hpp.

Referenced by nfd::name_tree::NameTree::getMaxDepth(), and nfd::fib::Fib::getMaxDepth().

◆ PrivilegeHelper

Definition at line 34 of file privilege-helper.cpp.

◆ FaceTable

Definition at line 37 of file face-table.cpp.

◆ Forwarder

Definition at line 38 of file forwarder.cpp.

◆ CommandAuthenticator

◆ FaceManager

Definition at line 38 of file face-manager.cpp.

◆ FibManager

Definition at line 36 of file fib-manager.cpp.

◆ StrategyChoiceManager

◆ Nfd

Definition at line 46 of file nfd.cpp.

◆ INTERNAL_CONFIG

const std::string nfd::INTERNAL_CONFIG = "internal://nfd.conf"
static

Definition at line 48 of file nfd.cpp.

Referenced by nfd::Nfd::reloadConfigFile().