All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ndn::nfd::Controller Class Reference

NFD Management protocol - ControlCommand client. More...

#include <nfd-controller.hpp>

Inheritance diagram for ndn::nfd::Controller:
[legend]
Collaboration diagram for ndn::nfd::Controller:
[legend]

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...
 
typedef function< void()> SuccessCallback
 
typedef function< void(const
std::string &)> 
FailCallback
 

Public Member Functions

 Controller (Face &face)
 
template<typename Command >
void start (const ControlParameters &parameters, const CommandSucceedCallback &onSuccess, const CommandFailCallback &onFailure, time::milliseconds timeout=getDefaultCommandTimeout())
 start command execution More...
 
virtual void selfRegisterPrefix (const Name &prefixToRegister, const SuccessCallback &onSuccess, const FailCallback &onFail)
 
virtual void selfDeregisterPrefix (const Name &prefixToDeRegister, const SuccessCallback &onSuccess, const FailCallback &onFail)
 

Static Public Member Functions

static time::milliseconds getDefaultCommandTimeout ()
 

Protected Attributes

Facem_face
 
CommandInterestGenerator m_commandInterestGenerator
 

Detailed Description

NFD Management protocol - ControlCommand client.

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

Member Typedef Documentation

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

a callback on command failure

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

a callback on command success

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

typedef function<void(const std::string&)> ndn::Controller::FailCallback
inherited

Definition at line 24 of file controller.hpp.

typedef function<void()> ndn::Controller::SuccessCallback
inherited

Definition at line 23 of file controller.hpp.

Constructor & Destructor Documentation

ndn::nfd::Controller::Controller ( Face face)
explicit

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

Member Function Documentation

static time::milliseconds ndn::nfd::Controller::getDefaultCommandTimeout ( )
inlinestatic

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

void ndn::nfd::Controller::selfDeregisterPrefix ( const Name prefixToDeRegister,
const SuccessCallback onSuccess,
const FailCallback onFail 
)
virtual

Implements ndn::Controller.

Reimplemented in ndn::nrd::Controller.

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

void ndn::nfd::Controller::selfRegisterPrefix ( const Name prefixToRegister,
const SuccessCallback onSuccess,
const FailCallback onFail 
)
virtual

Implements ndn::Controller.

Reimplemented in ndn::nrd::Controller.

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

template<typename Command >
void ndn::nfd::Controller::start ( const ControlParameters parameters,
const CommandSucceedCallback onSuccess,
const CommandFailCallback onFailure,
time::milliseconds  timeout = getDefaultCommandTimeout() 
)

start command execution

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

Field Documentation

CommandInterestGenerator ndn::nfd::Controller::m_commandInterestGenerator
protected

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

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

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