#include <nlsr.hpp>

Collaboration diagram for nlsr::Nlsr:

Data Structures
class	Error

Public Types
using	FetchDatasetCallback = std::function< void(const std::vector< ndn::nfd::FaceStatus > &)>

using	FetchDatasetTimeoutCallback = std::function< void(uint32_t, const std::string &)>

Public Member Functions
	Nlsr (ndn::Face &face, ndn::KeyChain &keyChain, ConfParameter &confParam)

void	registrationFailed (const ndn::Name &name)

void	onRegistrationSuccess (const ndn::Name &name)

void	setInfoInterestFilter ()

void	setLsaInterestFilter ()

void	addDispatcherTopPrefix (const ndn::Name &topPrefix)
	Add top level prefixes for Dispatcher. More...

Fib &	getFib ()

void	initialize ()

void	initializeFaces (const FetchDatasetCallback &onFetchSuccess, const FetchDatasetTimeoutCallback &onFetchFailure)
	Initializes neighbors' Faces using information from NFD. More...

void	onFaceDatasetFetchTimeout (uint32_t code, const std::string &reason, uint32_t nRetriesSoFar)

void	processFaceDataset (const std::vector< ndn::nfd::FaceStatus > &faces)
	Consumes a Face StatusDataset to configure NLSR neighbors. More...

void	registerAdjacencyPrefixes (const Adjacent &adj, const ndn::time::milliseconds &timeout)
	Registers NLSR-specific prefixes for a neighbor (Adjacent) More...

void	loadCertToPublish (const ndn::security::v2::Certificate &certificate)
	Add a certificate NLSR claims to be authoritative for to the certificate store. More...

void	afterFetcherSignalEmitted (const ndn::Data &lsaSegment)
	Callback when SegmentFetcher retrieves a segment. More...

void	publishCertFromCache (const ndn::Name &keyName)
	Retrieves the chain of certificates from Validator's cache and store them in Nlsr's own CertificateStore. More...

void	initializeKey ()

const ndn::security::v2::Certificate *	getCertificate (const ndn::Name &certificateKeyName)
	Find a certificate. More...

void	setStrategies ()

Static Public Attributes
static const ndn::Name	LOCALHOST_PREFIX = ndn::Name("/localhost/nlsr")

Friends
class	NlsrRunner

Detailed Description

Definition at line 67 of file nlsr.hpp.

Member Typedef Documentation

using nlsr::Nlsr::FetchDatasetCallback = std::function<void(const std::vector<ndn::nfd::FaceStatus>&)>

Definition at line 70 of file nlsr.hpp.

using nlsr::Nlsr::FetchDatasetTimeoutCallback = std::function<void(uint32_t, const std::string&)>

Definition at line 71 of file nlsr.hpp.

Constructor & Destructor Documentation

nlsr::Nlsr::Nlsr	(	ndn::Face &	face,
		ndn::KeyChain &	keyChain,
		ConfParameter &	confParam
	)

Definition at line 42 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

void nlsr::Nlsr::addDispatcherTopPrefix ( const ndn::Name & topPrefix )

Add top level prefixes for Dispatcher.

All dispatcher-related sub-prefixes must be registered before sub-prefixes must be added before adding top

Definition at line 124 of file nlsr.cpp.

Here is the caller graph for this function:

void nlsr::Nlsr::afterFetcherSignalEmitted ( const ndn::Data & lsaSegment )

Callback when SegmentFetcher retrieves a segment.

Definition at line 157 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

const ndn::security::v2::Certificate* nlsr::Nlsr::getCertificate ( const ndn::Name & certificateKeyName )

inline

Find a certificate.

Find a certificate that NLSR has. First it checks against the certificates this NLSR claims to be authoritative for, usually something like this specific router's certificate, and then checks the cache of certficates it has already fetched. If none can be found, it will return an empty pointer.

Definition at line 190 of file nlsr.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Fib& nlsr::Nlsr::getFib ( )

inline

Definition at line 106 of file nlsr.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::initialize ( )

Definition at line 195 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::initializeFaces	(	const FetchDatasetCallback &	onFetchSuccess,
		const FetchDatasetTimeoutCallback &	onFetchFailure
	)

Initializes neighbors' Faces using information from NFD.

See also: Nlsr::initialize(); Nlsr::processFaceDataset()

This function serves as the entry-point for initializing the neighbors listed in nlsr.conf during Nlsr::initialize(). NLSR will attempt to fetch a dataset of Faces from NFD, and configure each of its neighbors using information from that dataset. The explicit callbacks allow for better testability.

Definition at line 472 of file nlsr.cpp.

Here is the caller graph for this function:

void nlsr::Nlsr::initializeKey ( )

Definition at line 246 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::loadCertToPublish ( const ndn::security::v2::Certificate & certificate )

Add a certificate NLSR claims to be authoritative for to the certificate store.

See also: CertificateStore

Definition at line 145 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::onFaceDatasetFetchTimeout	(	uint32_t	code,
		const std::string &	reason,
		uint32_t	nRetriesSoFar
	)

Definition at line 536 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::onRegistrationSuccess ( const ndn::Name & name )

Definition at line 88 of file nlsr.cpp.

Here is the caller graph for this function:

void nlsr::Nlsr::processFaceDataset ( const std::vector< ndn::nfd::FaceStatus > & faces )

Consumes a Face StatusDataset to configure NLSR neighbors.

See also: Nlsr::initializeFaces

Parameters

faces A Face Dataset that should conform to FaceMgmt specifications.

This function processes a Face StatusDataset that should conform to the FaceMgmt specifications listed here. Any newly configured neighbors will have prefixes registered with NFD and be sent Hello Interests as well.

Definition at line 482 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::publishCertFromCache ( const ndn::Name & keyName )

Retrieves the chain of certificates from Validator's cache and store them in Nlsr's own CertificateStore.

Parameters

keyName Name of the first key in the certificate chain.

Definition at line 170 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::registerAdjacencyPrefixes	(	const Adjacent &	adj,
		const ndn::time::milliseconds &	timeout
	)

Registers NLSR-specific prefixes for a neighbor (Adjacent)

See also: Nlsr::initializeFaces

Parameters

adj	A reference to the neighbor to register prefixes for
timeout	The amount of time to give NFD to respond to each registration request.

Registers the prefixes in NFD that NLSR needs to route with a neighbor. The timeout given is how long to set the timeout for each registration request that is made.

Definition at line 516 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::registrationFailed ( const ndn::Name & name )

Definition at line 81 of file nlsr.cpp.

Here is the caller graph for this function:

void nlsr::Nlsr::setInfoInterestFilter ( )

Definition at line 94 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::setLsaInterestFilter ( )

Definition at line 110 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nlsr::Nlsr::setStrategies ( )

Definition at line 136 of file nlsr.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class NlsrRunner

friend

Definition at line 305 of file nlsr.hpp.

Field Documentation

const ndn::Name nlsr::Nlsr::LOCALHOST_PREFIX = ndn::Name("/localhost/nlsr")

static

Definition at line 260 of file nlsr.hpp.

NLSR - Named Data Link State Routing Protocol 0.5.0 documentation

Data Structures

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation