nfd::ManagerBase Class Reference

a collection of common functions shared by all NFD managers and RIB manager, such as communicating with the dispatcher and command validator. More...

#include <manager-base.hpp>

Inheritance diagram for nfd::ManagerBase:

Collaboration diagram for nfd::ManagerBase:

Classes
class	Error

Public Member Functions
	ManagerBase (Dispatcher &dispatcher, const std::string &module)
virtual	~ManagerBase ()
const std::string &	getModule () const

Protected Types
using	ControlCommandHandler = std::function< void(const ControlCommand &command, const Name &prefix, const Interest &interest, const ControlParameters &parameters, const ndn::mgmt::CommandContinuation done)>

Protected Member Functions
template<typename Command >
void	registerCommandHandler (const std::string &verb, const ControlCommandHandler &handler)
void	registerStatusDatasetHandler (const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
ndn::mgmt::PostNotification	registerNotificationStream (const std::string &verb)
void	extractRequester (const Interest &interest, ndn::mgmt::AcceptContinuation accept)
	extract a requester from a ControlCommand request More...

Detailed Description

a collection of common functions shared by all NFD managers and RIB manager, such as communicating with the dispatcher and command validator.

Definition at line 48 of file manager-base.hpp.

Member Typedef Documentation

ControlCommandHandler

using nfd::ManagerBase::ControlCommandHandler = std::function<void(const ControlCommand& command, const Name& prefix, const Interest& interest, const ControlParameters& parameters, const ndn::mgmt::CommandContinuation done)>

protected

Definition at line 78 of file manager-base.hpp.

Constructor & Destructor Documentation

ManagerBase()

nfd::ManagerBase::ManagerBase	(	Dispatcher &	dispatcher,
		const std::string &	module
	)

Definition at line 33 of file manager-base.cpp.

~ManagerBase()

nfd::ManagerBase::~ManagerBase ( )

virtualdefault

Member Function Documentation

getModule()

const std::string& nfd::ManagerBase::getModule ( ) const

inline

Definition at line 68 of file manager-base.hpp.

registerCommandHandler()

template<typename Command >

void nfd::ManagerBase::registerCommandHandler ( const std::string &  verb, const ControlCommandHandler &  handler  )

inlineprotected

Definition at line 156 of file manager-base.hpp.

References ndn::mgmt::Dispatcher::addControlCommand().

registerStatusDatasetHandler()

void nfd::ManagerBase::registerStatusDatasetHandler ( const std::string &  verb, const ndn::mgmt::StatusDatasetHandler &  handler  )

protected

Definition at line 42 of file manager-base.cpp.

References ndn::mgmt::Dispatcher::addStatusDataset(), and ndn::mgmt::makeAcceptAllAuthorization().

Referenced by nfd::CsManager::CsManager(), nfd::FaceManager::FaceManager(), nfd::FibManager::FibManager(), and nfd::StrategyChoiceManager::StrategyChoiceManager().

registerNotificationStream()

ndn::mgmt::PostNotification nfd::ManagerBase::registerNotificationStream ( const std::string &  verb )

protected

Definition at line 51 of file manager-base.cpp.

References ndn::mgmt::Dispatcher::addNotificationStream().

Referenced by nfd::FaceManager::FaceManager().

extractRequester()

void nfd::ManagerBase::extractRequester ( const Interest &  interest, ndn::mgmt::AcceptContinuation  accept  )

protected

extract a requester from a ControlCommand request

This is called after the signature is validated.

Parameters

interest	a request for ControlCommand
accept	callback of successful validation, take the requester string as a argument

Definition at line 57 of file manager-base.cpp.

References ndn::Name::at(), ndn::Block::blockFromValue(), ndn::Interest::getName(), ndn::KeyLocator::KeyLocator_Name, and ndn::signed_interest::POS_SIG_INFO.

---

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

• ndnSIM/NFD/core/manager-base.hpp
• ndnSIM/NFD/core/manager-base.cpp