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

	tools

	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	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	Logger
	provides logging for a module More...

class	LoggerFactory

struct	LoggerTimestamp
	a tag that writes a timestamp upon stream output 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 NetworkInterfaceInfo. 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	NfdManagerBase
	a collection of common functions shared by all NFD managers, such as communicating with the dispatcher and command validator. 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
typedef boost::property_tree::ptree	ConfigSection
	a config file section More...

typedef function< void(const ConfigSection &section, bool isDryRun, const std::string &filename)>	ConfigSectionHandler
	callback to process a config file section More...

typedef boost::optional< const ConfigSection & >	OptionalConfigSection
	an optional config file section More...

using	SignerTag = ndn::SimpleTag< Name, 20 >
	an Interest tag to indicate command signer More...

typedef function< void(const std::string &filename, const std::string &sectionName, const ConfigSection &section, bool isDryRun)>	UnknownConfigSectionHandler
	callback to process a config file section without a `ConfigSectionHandler` More...

Enumerations
enum	LogLevel { LOG_FATAL = -1, LOG_NONE = 0, LOG_ERROR = 1, LOG_WARN = 2, LOG_INFO = 3, LOG_DEBUG = 4, LOG_TRACE = 5, LOG_ALL = 255 }
	indicates a log level More...

Functions
void	cleanupOnFaceRemoval (NameTree &nt, Fib &fib, Pit &pit, const Face &face)
	cleanup tables when a face is destroyed More...

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

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

static bool	doesMatchRule (const ndn::net::NetworkInterface &netif, const std::string &rule)

template<typename It , typename Pred >
It	find_last_if (It first, It last, Pred p)
	finds the last element satisfying a predicate More...

static Name	getDefaultStrategyName ()

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

boost::asio::io_service &	getGlobalIoService ()

std::mt19937 &	getGlobalRng ()

static ndn::optional< std::string >	getSignerFromTag (const Interest &interest)
	obtain signer from SignerTag attached to Interest, if available More...

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

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

	NFD_ASSERT_FORWARD_ITERATOR (FaceTable::const_iterator)

std::ostream &	operator<< (std::ostream &os, const LoggerTimestamp &)
	write a timestamp to `os` More...

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

std::ostream &	operator<< (std::ostream &output, const Logger &logger)

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

static void	parseList (std::set< std::string > &set, const boost::property_tree::ptree &list, const std::string &section)

static void	printLogModules (std::ostream &os)

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

void	resetGlobalIoService ()

static const time::milliseconds	STATUS_FRESHNESS (5000)

Variables
static const int	FIB_MAX_DEPTH = 32
	Maximum number of components in a FIB entry prefix. More...

static boost::thread_specific_ptr< boost::asio::io_service >	g_ioService

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

Detailed Description

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.

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-2016, Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

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

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

a config file section

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

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

callback to process a config file section

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

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

an optional config file section

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

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

an Interest tag to indicate command signer

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

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

callback to process a config file section without a ConfigSectionHandler

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

Enumeration Type Documentation

enum nfd::LogLevel

indicates a log level

Note: This type is internal. Logger should be accessed through NFD_LOG_* macros.

Enumerator
LOG_FATAL
LOG_NONE
LOG_ERROR
LOG_WARN
LOG_INFO
LOG_DEBUG
LOG_TRACE
LOG_ALL

Definition at line 42 of file logger.hpp.

Function Documentation

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.

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

inlinestatic

Definition at line 495 of file forwarder.cpp.

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

static

Definition at line 99 of file network-interface-predicate.cpp.

static bool nfd::doesMatchRule	(	const ndn::net::NetworkInterface &	netif,
		const std::string &	rule
	)

static

Definition at line 107 of file network-interface-predicate.cpp.

template<typename It , typename Pred >

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

finds the last element satisfying a predicate

Template Parameters

It	BidirectionalIterator
Pred	UnaryPredicate

Returns: Iterator to the last element satisfying the condition, or last if no such element is found.

Complexity: at most last-first invocations of p

Definition at line 49 of file algorithm.hpp.

static Name nfd::getDefaultStrategyName ( )

static

Definition at line 39 of file forwarder.cpp.

template<typename E >

std::string nfd::getExtendedErrorMessage ( const E & exception )

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

boost::asio::io_service & nfd::getGlobalIoService ( )

Returns: the global io_service instance

Definition at line 41 of file global-io.cpp.

std::mt19937 & nfd::getGlobalRng ( )

Returns: the global random number generator instance

Definition at line 32 of file random.cpp.

static ndn::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.

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.

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

inlinestatic

Definition at line 536 of file forwarder.cpp.

nfd::NFD_ASSERT_FORWARD_ITERATOR ( FaceTable::const_iterator )

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

write a timestamp to os

Note: This function is thread-safe.

Definition at line 46 of file logger.cpp.

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

Definition at line 94 of file network.cpp.

std::ostream& nfd::operator<<	(	std::ostream &	output,
		const Logger &	logger
	)

inline

Definition at line 96 of file logger.hpp.

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

Definition at line 100 of file network.cpp.

static void nfd::parseList	(	std::set< std::string > &	set,
		const boost::property_tree::ptree &	list,
		const std::string &	section
	)

static

Definition at line 48 of file network-interface-predicate.cpp.

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

static

Definition at line 209 of file main.cpp.

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

static

Definition at line 199 of file main.cpp.

void nfd::resetGlobalIoService ( )

Definition at line 50 of file global-io.cpp.

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

static

Variable Documentation

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.

boost::thread_specific_ptr<boost::asio::io_service> nfd::g_ioService

static

Definition at line 38 of file global-io.cpp.

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

static

Definition at line 48 of file nfd.cpp.

NFD: Named Data Networking Forwarding Daemon 0.6.1 documentation

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation