NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
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_SERVER = 500
 error code for server error More...
static const uint32_t ERROR_LBOUND = 400
 inclusive lower bound of error codes More...

Protected Attributes

KeyChain & m_keyChain

Detailed Description

NFD Management protocol - ControlCommand client.

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

Member Typedef Documentation

a callback on command success

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

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

a callback on command failure

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

Constructor & Destructor Documentation

Member Function Documentation

template<typename Command >
void ndn::nfd::Controller::start ( const ControlParameters parameters,
const CommandSucceedCallback onSuccess,
const CommandFailCallback onFailure,
const CommandOptions options = CommandOptions() 

Member Data Documentation

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

error code for server error

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

Referenced by Controller().

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

inclusive lower bound of error codes

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

Referenced by Controller().

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

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

Referenced by Controller().

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

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

Referenced by Controller().

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