Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
nfd::CsManager Class Referencefinal

Implements the CS Management of NFD Management Protocol. More...

#include <daemon/mgmt/cs-manager.hpp>

+ Inheritance diagram for nfd::CsManager:
+ Collaboration diagram for nfd::CsManager:

Public Member Functions

 CsManager (cs::Cs &cs, const ForwarderCounters &fwCounters, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
 
const std::string & getModule () const
 

Static Public Attributes

static constexpr size_t ERASE_LIMIT = 256
 

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)
 
ndn::mgmt::PostNotification registerNotificationStream (const std::string &verb)
 
void registerStatusDatasetHandler (const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
 

Static Protected Member Functions

static std::string extractSigner (const Interest &interest)
 Extracts the name from the KeyLocator of a ControlCommand request. More...
 

Detailed Description

Implements the CS Management of NFD Management Protocol.

See also
https://redmine.named-data.net/projects/nfd/wiki/CsMgmt

Definition at line 43 of file cs-manager.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)>
protectedinherited

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

Constructor & Destructor Documentation

◆ CsManager()

nfd::CsManager::CsManager ( cs::Cs &  cs,
const ForwarderCounters &  fwCounters,
Dispatcher &  dispatcher,
CommandAuthenticator &  authenticator 
)

Definition at line 34 of file cs-manager.cpp.

Member Function Documentation

◆ extractSigner()

std::string nfd::ManagerBase::extractSigner ( const Interest &  interest)
staticprotectedinherited

Extracts the name from the KeyLocator of a ControlCommand request.

This is called after the signature has been validated. Returns an empty string if SignatureInfo or KeyLocator are missing or malformed.

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

◆ getModule()

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

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

◆ registerCommandHandler()

template<typename Command >
void nfd::ManagerBase::registerCommandHandler ( const std::string &  verb,
const ControlCommandHandler &  handler 
)
protectedinherited

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

◆ registerNotificationStream()

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

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

◆ registerStatusDatasetHandler()

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

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

Member Data Documentation

◆ ERASE_LIMIT

constexpr size_t nfd::CsManager::ERASE_LIMIT = 256
staticconstexpr

Definition at line 69 of file cs-manager.hpp.