NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: 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
 
 face
 
 fib
 
 fw
 
 general
 
 measurements
 
 name_tree
 
 pit
 
 rib
 
 scheduler
 
 strategy_choice
 
 tcp
 
 tlv
 
 udp
 
 unix_stream
 
 websocket
 

Classes

class  ByteCounter
 represents a counter of number of bytes More...
 
class  Channel
 
class  CommandValidator
 
class  ConfigFile
 
class  DeadNonceList
 represents the Dead Nonce list More...
 
class  EthernetFactory
 
class  FaceManager
 implement the Face Management of NFD Management Protocol. More...
 
class  FaceTable
 container of all Faces More...
 
class  Fib
 represents the FIB 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  ManagerBase
 a collection of common functions shared by all NFD managers, such as communicating with the dispatcher and command validator. More...
 
class  Measurements
 represents the Measurements table More...
 
class  MeasurementsAccessor
 allows Strategy to access portion of Measurements table under its namespace More...
 
class  NameTree
 Class Name Tree. More...
 
class  Network
 
class  NetworkInterfaceInfo
 contains information about a network interface More...
 
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  NfdRunner
 Executes NFD with RIB manager. More...
 
class  PacketCounter
 represents a counter of number of packets More...
 
class  Pit
 represents the Interest Table More...
 
class  PrivilegeHelper
 
class  ProtocolFactory
 Abstract base class for all protocol factories. More...
 
class  RttEstimator
 implements the Mean-Deviation RTT estimator More...
 
class  SegmentPublisher
 provides a publisher of Status Dataset or other segmented octet stream 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  StrategyChoice
 represents the Strategy Choice table More...
 
class  StrategyChoiceManager
 implement the Strategy Choice Management of NFD Management Protocol. More...
 
class  StrategyInfoHost
 base class for an entity onto which StrategyInfo objects may be placed More...
 
class  TablesConfigSection
 Provides parsing for tables configuration file section. More...
 
class  TcpChannel
 Class implementing TCP-based channel to create faces. More...
 
class  TcpFactory
 
class  UdpChannel
 Class implementing UDP-based channel to create faces. More...
 
class  UdpFactory
 
class  UnixStreamChannel
 Class implementing a local channel to create faces. More...
 
class  UnixStreamFactory
 
class  WebSocketChannel
 Class implementing WebSocket-based channel to create faces. More...
 
class  WebSocketFactory
 

Typedefs

typedef boost::property_tree::ptree ConfigSection
 
typedef function< void(const ConfigSection &, bool, const std::string &)> ConfigSectionHandler
 callback for config file sections More...
 
typedef function< void(const std::string &, const std::string &, const ConfigSection &, bool)> UnknownConfigSectionHandler
 callback for config file sections without a subscribed handler More...
 
typedef function< void(const shared_ptr< Face > &newFace)> FaceCreatedCallback
 Prototype for the callback that is invoked when the face is created (as a response to incoming connection or after connection is established) More...
 
typedef function< void(const std::string &reason)> FaceCreationFailedCallback
 Prototype for the callback that is invoked when the face fails to be created. More...
 

Functions

It find_last_if (It first, It last, Pred p)
 
template<typename E >
std::string getExtendedErrorMessage (const E &exception)
 
detail::SimulatorIogetGlobalIoService ()
 
std::vector< NetworkInterfaceInfolistNetworkInterfaces ()
 List configured network interfaces on the system and their info. More...
 
std::ostream & operator<< (std::ostream &os, const Network &network)
 
std::istream & operator>> (std::istream &is, Network &network)
 
boost::random::mt19937 & getGlobalRng ()
 
void resetGlobalRng ()
 
void connectFaceClosedSignal (Face &face, const std::function< void()> &f)
 invokes a callback when the face is closed More...
 
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 aggregateErrors (std::stringstream &ss, const std::string &msg)
 
static ndn::util::NetworkMonitormakeNetworkMonitor ()
 
static void ignoreRibAndLogSections (const std::string &filename, const std::string &sectionName, const ConfigSection &section, bool isDryRun)
 
static bool predicate_NameTreeEntry_hasFibEntry (const name_tree::Entry &entry)
 
static void clearStrategyInfo (const name_tree::Entry &nte)
 

Variables

 PrivilegeHelper
 
static boost::thread_specific_ptr< boost::random::mt19937 > g_rng
 
 TcpChannel
 
 TcpFactory
 
 UdpChannel
 
 UdpFactory
 
 UnixStreamChannel
 
 WebSocketChannel
 
 FaceTable
 
 Forwarder
 
 NFD
 
 CommandValidator
 
 FaceManager
 
 FibManager
 
const time::milliseconds STATUS_SERVER_DEFAULT_FRESHNESS = time::milliseconds(5000)
 
 StrategyChoiceManager
 
 TablesConfigSection
 
 Nfd
 
static const std::string INTERNAL_CONFIG = "internal://nfd.conf"
 
 NameTree
 
 StrategyChoice
 

Detailed Description

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

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, 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-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/.

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/. This file declares the global random number generator All random numbers in NFD should use this global random number generator, so that the generator can be properly seeded when necessary.

This random number generator is not suitable for security purposes; security-critical code should use CryptoPP random number generator instead.

Typedef Documentation

§ ConfigSection

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

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

§ ConfigSectionHandler

typedef function<void(const ConfigSection& , bool , const std::string& )> nfd::ConfigSectionHandler

callback for config file sections

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

§ UnknownConfigSectionHandler

typedef function<void(const std::string& , const std::string& , const ConfigSection& , bool )> nfd::UnknownConfigSectionHandler

callback for config file sections without a subscribed handler

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

§ FaceCreatedCallback

typedef function<void(const shared_ptr<Face>& newFace)> nfd::FaceCreatedCallback

Prototype for the callback that is invoked when the face is created (as a response to incoming connection or after connection is established)

Definition at line 38 of file channel.hpp.

§ FaceCreationFailedCallback

typedef function<void(const std::string& reason)> nfd::FaceCreationFailedCallback

Prototype for the callback that is invoked when the face fails to be created.

Definition at line 44 of file channel.hpp.

Function Documentation

§ find_last_if()

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

Definition at line 49 of file algorithm.hpp.

Referenced by nfd::cs::Cs::find().

§ getExtendedErrorMessage()

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

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

References ndn::security::file.

Referenced by main().

§ getGlobalIoService()

§ listNetworkInterfaces()

§ operator<<()

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

Definition at line 58 of file network.cpp.

References nfd::Network::print().

§ operator>>()

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

Definition at line 65 of file network.cpp.

§ getGlobalRng()

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

Definition at line 34 of file random.cpp.

References g_rng.

Referenced by nfd::fw::NccStrategy::doPropagate(), and nfd::Forwarder::startProcessNack().

§ resetGlobalRng()

void nfd::resetGlobalRng ( )

Definition at line 43 of file random.cpp.

§ connectFaceClosedSignal()

void nfd::connectFaceClosedSignal ( Face &  face,
const std::function< void()> &  f 
)

invokes a callback when the face is closed

Parameters
facethe face
fthe callback to be invoked when the face enters CLOSED state

This function connects a callback to the afterStateChange signal on the face, and invokes f when the state becomes CLOSED.

Definition at line 41 of file channel.cpp.

Referenced by nfd::FaceTable::addReserved(), nfd::EthernetFactory::createMulticastFace(), nfd::UdpFactory::createMulticastFace(), nfd::Channel::getUri(), nfd::UdpChannel::listen(), nfd::TcpChannel::size(), and nfd::WebSocketChannel::WebSocketChannel().

§ compare_InRecord_expiry()

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

§ insertNonceToDnl()

§ aggregateErrors()

static void nfd::aggregateErrors ( std::stringstream &  ss,
const std::string &  msg 
)
inlinestatic

Definition at line 56 of file command-validator.cpp.

Referenced by nfd::CommandValidator::onConfig().

§ makeNetworkMonitor()

static ndn::util::NetworkMonitor* nfd::makeNetworkMonitor ( )
inlinestatic

Definition at line 52 of file nfd.cpp.

References getGlobalIoService(), and NFD_LOG_WARN.

§ ignoreRibAndLogSections()

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

§ predicate_NameTreeEntry_hasFibEntry()

static bool nfd::predicate_NameTreeEntry_hasFibEntry ( const name_tree::Entry entry)
inlinestatic

§ clearStrategyInfo()

Variable Documentation

§ PrivilegeHelper

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

§ g_rng

boost::thread_specific_ptr<boost::random::mt19937> nfd::g_rng
static

Definition at line 31 of file random.cpp.

Referenced by getGlobalRng().

§ TcpChannel

Definition at line 33 of file tcp-channel.cpp.

§ TcpFactory

Definition at line 34 of file tcp-factory.cpp.

§ UdpChannel

Definition at line 33 of file udp-channel.cpp.

§ UdpFactory

Definition at line 42 of file udp-factory.cpp.

§ UnixStreamChannel

§ WebSocketChannel

Definition at line 33 of file websocket-channel.cpp.

§ FaceTable

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

§ Forwarder

Definition at line 38 of file forwarder.cpp.

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

§ NFD

nfd::NFD

Definition at line 51 of file main.cpp.

§ CommandValidator

§ FaceManager

§ FibManager

§ STATUS_SERVER_DEFAULT_FRESHNESS

const time::milliseconds nfd::STATUS_SERVER_DEFAULT_FRESHNESS = time::milliseconds(5000)

Definition at line 32 of file forwarder-status-manager.cpp.

§ StrategyChoiceManager

§ TablesConfigSection

§ Nfd

Definition at line 47 of file nfd.cpp.

§ INTERNAL_CONFIG

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

Definition at line 49 of file nfd.cpp.

§ NameTree

Definition at line 36 of file name-tree.cpp.

§ StrategyChoice

Definition at line 37 of file strategy-choice.cpp.