ndn::nfd::Controller Class Reference

NFD Management protocol - ControlCommand client. More...

#include <nfd-controller.hpp>

Inheritance diagram for ndn::nfd::Controller:

Collaboration diagram for ndn::nfd::Controller:

Public Types
typedef function< void(const ControlParameters &)>	CommandSucceedCallback
	a callback on command success More...
typedef function< void(uint32_t, const std::string &)>	CommandFailCallback
	a callback on command failure More...

Public Member Functions
	Controller (Face &face, KeyChain &keyChain)
	construct a Controller that uses face for transport, and uses the passed KeyChain to sign commands More...
template<typename Command >
void	start (const ControlParameters &parameters, const CommandSucceedCallback &onSuccess, const CommandFailCallback &onFailure, const CommandOptions &options=CommandOptions())
	start command execution More...

Static Public Attributes
static const uint32_t	ERROR_TIMEOUT = 10060
	error code for timeout More...
static const uint32_t	ERROR_NACK = 10800
	error code for network Nack More...
static const uint32_t	ERROR_SERVER = 500
	error code for server error More...
static const uint32_t	ERROR_LBOUND = 400
	inclusive lower bound of error codes More...

Protected Attributes
Face &	m_face
KeyChain &	m_keyChain

Detailed Description

NFD Management protocol - ControlCommand client.

Definition at line 42 of file nfd-controller.hpp.

Member Typedef Documentation

CommandSucceedCallback

typedef function<void(const ControlParameters&)> ndn::nfd::Controller::CommandSucceedCallback

a callback on command success

Definition at line 47 of file nfd-controller.hpp.

CommandFailCallback

typedef function<void(uint32_t,const std::string&)> ndn::nfd::Controller::CommandFailCallback

a callback on command failure

Definition at line 51 of file nfd-controller.hpp.

Constructor & Destructor Documentation

Controller()

ndn::nfd::Controller::Controller	(	Face &	face,
		KeyChain &	keyChain
	)

construct a Controller that uses face for transport, and uses the passed KeyChain to sign commands

Definition at line 33 of file nfd-controller.cpp.

References ndn::Block::blockFromValue(), ERROR_LBOUND, ERROR_NACK, ERROR_SERVER, ERROR_TIMEOUT, ndn::Face::expressInterest(), ndn::mgmt::ControlResponse::getBody(), ndn::mgmt::ControlResponse::getCode(), ndn::Data::getContent(), ndn::nfd::CommandOptions::getPrefix(), ndn::nfd::CommandOptions::getSigningInfo(), ndn::mgmt::ControlResponse::getText(), ndn::nfd::CommandOptions::getTimeout(), m_face, m_keyChain, ndn::Interest::setInterestLifetime(), ndn::security::KeyChain::sign(), ndn::mgmt::ControlResponse::wireDecode(), and ndn::nfd::ControlParameters::wireDecode().

Member Function Documentation

start()

template<typename Command >

void ndn::nfd::Controller::start ( const ControlParameters &  parameters, const CommandSucceedCallback &  onSuccess, const CommandFailCallback &  onFailure, const CommandOptions &  options = CommandOptions()  )

inline

start command execution

Definition at line 62 of file nfd-controller.hpp.

Referenced by nfd::rib::FibUpdater::computeAndSendFibUpdates(), nfd::rib::AutoPrefixPropagator::disable(), nfd::rib::RibManager::enableLocalControlHeader(), and nfd::rib::RibManager::~RibManager().

Member Data Documentation

ERROR_TIMEOUT

const uint32_t ndn::nfd::Controller::ERROR_TIMEOUT = 10060

static

error code for timeout

Definition at line 88 of file nfd-controller.hpp.

Referenced by nfd::rib::FibUpdater::computeAndSendFibUpdates(), and Controller().

ERROR_NACK

const uint32_t ndn::nfd::Controller::ERROR_NACK = 10800

static

error code for network Nack

Definition at line 92 of file nfd-controller.hpp.

Referenced by Controller().

ERROR_SERVER

const uint32_t ndn::nfd::Controller::ERROR_SERVER = 500

static

error code for server error

Definition at line 96 of file nfd-controller.hpp.

Referenced by Controller().

ERROR_LBOUND

const uint32_t ndn::nfd::Controller::ERROR_LBOUND = 400

static

inclusive lower bound of error codes

Definition at line 100 of file nfd-controller.hpp.

Referenced by Controller().

m_face

Face& ndn::nfd::Controller::m_face

protected

Definition at line 103 of file nfd-controller.hpp.

Referenced by Controller().

m_keyChain

KeyChain& ndn::nfd::Controller::m_keyChain

protected

Definition at line 104 of file nfd-controller.hpp.

Referenced by Controller().

---

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

• ndnSIM/ndn-cxx/src/management/nfd-controller.hpp
• ndnSIM/ndn-cxx/src/management/nfd-controller.cpp