NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Member Functions | List of all members
ndn::nfd::ControlParameters Class Reference
Management

represents parameters in a ControlCommand request or response More...

#include <nfd-control-parameters.hpp>

Inheritance diagram for ndn::nfd::ControlParameters:
Inheritance graph
[legend]
Collaboration diagram for ndn::nfd::ControlParameters:
Collaboration graph
[legend]

Classes

class  Error
 

Public Member Functions

 ControlParameters ()
 
 ControlParameters (const Block &block)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 
virtual Block wireEncode () const final
 
virtual void wireDecode (const Block &wire) final
 
bool hasName () const
 
const Name & getName () const
 
ControlParameters & setName (const Name &name)
 
ControlParameters & unsetName ()
 
bool hasFaceId () const
 
uint64_t getFaceId () const
 
ControlParameters & setFaceId (uint64_t faceId)
 
ControlParameters & unsetFaceId ()
 
bool hasUri () const
 
const std::string & getUri () const
 
ControlParameters & setUri (const std::string &uri)
 
ControlParameters & unsetUri ()
 
bool hasLocalControlFeature () const
 
LocalControlFeature getLocalControlFeature () const
 
ControlParameters & setLocalControlFeature (LocalControlFeature localControlFeature)
 
ControlParameters & unsetLocalControlFeature ()
 
bool hasOrigin () const
 
uint64_t getOrigin () const
 
ControlParameters & setOrigin (uint64_t origin)
 
ControlParameters & unsetOrigin ()
 
bool hasCost () const
 
uint64_t getCost () const
 
ControlParameters & setCost (uint64_t cost)
 
ControlParameters & unsetCost ()
 
bool hasFlags () const
 
uint64_t getFlags () const
 
ControlParameters & setFlags (uint64_t flags)
 
ControlParameters & unsetFlags ()
 
bool hasStrategy () const
 
const Name & getStrategy () const
 
ControlParameters & setStrategy (const Name &strategy)
 
ControlParameters & unsetStrategy ()
 
bool hasExpirationPeriod () const
 
const time::milliseconds & getExpirationPeriod () const
 
ControlParameters & setExpirationPeriod (const time::milliseconds &expirationPeriod)
 
ControlParameters & unsetExpirationPeriod ()
 
bool hasFacePersistency () const
 
FacePersistency getFacePersistency () const
 
ControlParameters & setFacePersistency (FacePersistency persistency)
 
ControlParameters & unsetFacePersistency ()
 
const std::vector< bool > & getPresentFields () const
 

Detailed Description

represents parameters in a ControlCommand request or response

See also
http://redmine.named-data.net/projects/nfd/wiki/ControlCommand#ControlParameters

This type is copyable because it's an abstraction of a TLV type.

Definition at line 77 of file nfd-control-parameters.hpp.

Constructor & Destructor Documentation

§ ControlParameters() [1/2]

ndn::nfd::ControlParameters::ControlParameters ( )

Definition at line 36 of file nfd-control-parameters.cpp.

Referenced by ndn::nfd::ControlParameters::Error::Error().

§ ControlParameters() [2/2]

ndn::nfd::ControlParameters::ControlParameters ( const Block &  block)
explicit

Definition at line 41 of file nfd-control-parameters.cpp.

References wireDecode().

Member Function Documentation

§ wireEncode() [1/2]

template<encoding::Tag TAG>
size_t ndn::nfd::ControlParameters::wireEncode ( EncodingImpl< TAG > &  encoder) const

Definition at line 49 of file nfd-control-parameters.cpp.

References ndn::tlv::nfd::ControlParameters, ndn::tlv::nfd::Cost, ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::Flags, hasCost(), hasExpirationPeriod(), hasFaceId(), hasFacePersistency(), hasFlags(), hasLocalControlFeature(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalControlFeature, ndn::tlv::nfd::Origin, ndn::encoding::prependNestedBlock(), ndn::encoding::prependNonNegativeIntegerBlock(), ndn::tlv::nfd::Strategy, ndn::tlv::nfd::Uri, and ndn::Name::wireEncode().

Referenced by nfd::FibManager::FibManager(), ndn::nfd::ControlCommand::getRequestName(), nfd::FaceManager::setConfigFile(), nfd::rib::RibManager::setConfigFile(), and nfd::StrategyChoiceManager::StrategyChoiceManager().

§ wireEncode() [2/2]

Block ndn::nfd::ControlParameters::wireEncode ( ) const
finalvirtual

Implements ndn::mgmt::ControlParameters.

Definition at line 103 of file nfd-control-parameters.cpp.

References ndn::Block::hasWire().

Referenced by ndn::nfd::ControlParameters::Error::Error().

§ wireDecode()

void ndn::nfd::ControlParameters::wireDecode ( const Block &  wire)
finalvirtual

Implements ndn::mgmt::ControlParameters.

Definition at line 119 of file nfd-control-parameters.cpp.

References ndn::nfd::CONTROL_PARAMETER_COST, ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD, ndn::nfd::CONTROL_PARAMETER_FACE_ID, ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY, ndn::nfd::CONTROL_PARAMETER_FLAGS, ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE, ndn::nfd::CONTROL_PARAMETER_NAME, ndn::nfd::CONTROL_PARAMETER_ORIGIN, ndn::nfd::CONTROL_PARAMETER_STRATEGY, ndn::nfd::CONTROL_PARAMETER_URI, ndn::tlv::nfd::ControlParameters, ndn::tlv::nfd::Cost, ndn::Block::elements_end(), ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::Block::find(), ndn::tlv::nfd::Flags, hasCost(), hasExpirationPeriod(), hasFaceId(), hasFacePersistency(), hasFlags(), hasLocalControlFeature(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalControlFeature, ndn::tlv::Name, ndn::tlv::nfd::Origin, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::nfd::Strategy, ndn::Block::type(), ndn::tlv::nfd::Uri, and ndn::Name::wireDecode().

Referenced by ndn::nfd::Controller::Controller(), ControlParameters(), ndn::nfd::ControlParameters::Error::Error(), and nfd::rib::RibManager::setConfigFile().

§ hasName()

bool ndn::nfd::ControlParameters::hasName ( ) const
inline

Definition at line 108 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_NAME.

Referenced by getName(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getName()

const Name& ndn::nfd::ControlParameters::getName ( ) const
inline

Definition at line 114 of file nfd-control-parameters.hpp.

References hasName().

Referenced by nfd::rib::AutoPrefixPropagator::disable(), nfd::FibManager::FibManager(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), nfd::StrategyChoiceManager::StrategyChoiceManager(), and ndn::nfd::StrategyChoiceUnsetCommand::validateRequest().

§ setName()

ControlParameters& ndn::nfd::ControlParameters::setName ( const Name &  name)
inline

Definition at line 121 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_NAME.

Referenced by nfd::rib::AutoPrefixPropagator::disable(), and nfd::rib::RibManager::setConfigFile().

§ unsetName()

ControlParameters& ndn::nfd::ControlParameters::unsetName ( )
inline

Definition at line 130 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_NAME.

§ hasFaceId()

bool ndn::nfd::ControlParameters::hasFaceId ( ) const
inline

Definition at line 138 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::FibRemoveNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), getFaceId(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), wireDecode(), and wireEncode().

§ getFaceId()

uint64_t ndn::nfd::ControlParameters::getFaceId ( ) const
inline

Definition at line 144 of file nfd-control-parameters.hpp.

References hasFaceId().

Referenced by nfd::FibManager::FibManager(), nfd::rib::RibManager::onRibUpdateFailure(), ndn::nfd::operator<<(), nfd::FaceManager::setConfigFile(), nfd::rib::RibManager::setConfigFile(), ndn::nfd::FaceDestroyCommand::validateRequest(), ndn::nfd::FaceCreateCommand::validateResponse(), ndn::nfd::FibAddNextHopCommand::validateResponse(), ndn::nfd::FibRemoveNextHopCommand::validateResponse(), ndn::nfd::RibRegisterCommand::validateResponse(), and ndn::nfd::RibUnregisterCommand::validateResponse().

§ setFaceId()

ControlParameters& ndn::nfd::ControlParameters::setFaceId ( uint64_t  faceId)
inline

Definition at line 151 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::FibRemoveNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), ndn::util::DummyClientFace::DummyClientFace(), nfd::FibManager::FibManager(), nfd::rib::AutoPrefixPropagator::loadConfig(), nfd::FaceManager::setConfigFile(), and nfd::rib::RibManager::setConfigFile().

§ unsetFaceId()

ControlParameters& ndn::nfd::ControlParameters::unsetFaceId ( )
inline

Definition at line 160 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

§ hasUri()

bool ndn::nfd::ControlParameters::hasUri ( ) const
inline

Definition at line 168 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_URI.

Referenced by getUri(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getUri()

const std::string& ndn::nfd::ControlParameters::getUri ( ) const
inline

Definition at line 174 of file nfd-control-parameters.hpp.

References hasUri().

Referenced by ndn::nfd::operator<<(), and nfd::FaceManager::setConfigFile().

§ setUri()

ControlParameters& ndn::nfd::ControlParameters::setUri ( const std::string &  uri)
inline

Definition at line 181 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_URI.

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

§ unsetUri()

ControlParameters& ndn::nfd::ControlParameters::unsetUri ( )
inline

Definition at line 190 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_URI.

§ hasLocalControlFeature()

bool ndn::nfd::ControlParameters::hasLocalControlFeature ( ) const
inline

Definition at line 198 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

Referenced by getLocalControlFeature(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getLocalControlFeature()

LocalControlFeature ndn::nfd::ControlParameters::getLocalControlFeature ( ) const
inline

Definition at line 204 of file nfd-control-parameters.hpp.

References hasLocalControlFeature().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::FaceLocalControlCommand::validateRequest().

§ setLocalControlFeature()

ControlParameters& ndn::nfd::ControlParameters::setLocalControlFeature ( LocalControlFeature  localControlFeature)
inline

Definition at line 211 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

§ unsetLocalControlFeature()

ControlParameters& ndn::nfd::ControlParameters::unsetLocalControlFeature ( )
inline

Definition at line 220 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

§ hasOrigin()

bool ndn::nfd::ControlParameters::hasOrigin ( ) const
inline

Definition at line 228 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), getOrigin(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), wireDecode(), and wireEncode().

§ getOrigin()

uint64_t ndn::nfd::ControlParameters::getOrigin ( ) const
inline

Definition at line 234 of file nfd-control-parameters.hpp.

References hasOrigin().

Referenced by ndn::nfd::operator<<(), and nfd::rib::RibManager::setConfigFile().

§ setOrigin()

ControlParameters& ndn::nfd::ControlParameters::setOrigin ( uint64_t  origin)
inline

Definition at line 241 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), ndn::util::DummyClientFace::DummyClientFace(), nfd::rib::AutoPrefixPropagator::loadConfig(), and nfd::rib::RibManager::setConfigFile().

§ unsetOrigin()

ControlParameters& ndn::nfd::ControlParameters::unsetOrigin ( )
inline

Definition at line 250 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

§ hasCost()

bool ndn::nfd::ControlParameters::hasCost ( ) const
inline

Definition at line 258 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), getCost(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getCost()

uint64_t ndn::nfd::ControlParameters::getCost ( ) const
inline

Definition at line 264 of file nfd-control-parameters.hpp.

References hasCost().

Referenced by nfd::rib::AutoPrefixPropagator::disable(), nfd::FibManager::FibManager(), ndn::nfd::operator<<(), and nfd::rib::RibManager::setConfigFile().

§ setCost()

ControlParameters& ndn::nfd::ControlParameters::setCost ( uint64_t  cost)
inline

Definition at line 271 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), nfd::rib::AutoPrefixPropagator::disable(), ndn::util::DummyClientFace::DummyClientFace(), and nfd::rib::AutoPrefixPropagator::loadConfig().

§ unsetCost()

ControlParameters& ndn::nfd::ControlParameters::unsetCost ( )
inline

Definition at line 280 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by nfd::rib::AutoPrefixPropagator::disable().

§ hasFlags()

bool ndn::nfd::ControlParameters::hasFlags ( ) const
inline

Definition at line 288 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), getFlags(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getFlags()

uint64_t ndn::nfd::ControlParameters::getFlags ( ) const
inline

Definition at line 294 of file nfd-control-parameters.hpp.

References hasFlags().

Referenced by ndn::nfd::operator<<(), and nfd::rib::RibManager::setConfigFile().

§ setFlags()

ControlParameters& ndn::nfd::ControlParameters::setFlags ( uint64_t  flags)
inline

Definition at line 301 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest().

§ unsetFlags()

ControlParameters& ndn::nfd::ControlParameters::unsetFlags ( )
inline

Definition at line 310 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

§ hasStrategy()

bool ndn::nfd::ControlParameters::hasStrategy ( ) const
inline

Definition at line 318 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

Referenced by getStrategy(), ndn::nfd::operator<<(), wireDecode(), and wireEncode().

§ getStrategy()

const Name& ndn::nfd::ControlParameters::getStrategy ( ) const
inline

Definition at line 324 of file nfd-control-parameters.hpp.

References hasStrategy().

Referenced by ndn::nfd::operator<<(), and nfd::StrategyChoiceManager::StrategyChoiceManager().

§ setStrategy()

ControlParameters& ndn::nfd::ControlParameters::setStrategy ( const Name &  strategy)
inline

Definition at line 331 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

Referenced by nfd::StrategyChoiceManager::StrategyChoiceManager().

§ unsetStrategy()

ControlParameters& ndn::nfd::ControlParameters::unsetStrategy ( )
inline

Definition at line 340 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

§ hasExpirationPeriod()

bool ndn::nfd::ControlParameters::hasExpirationPeriod ( ) const
inline

Definition at line 348 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

Referenced by getExpirationPeriod(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), wireDecode(), and wireEncode().

§ getExpirationPeriod()

const time::milliseconds& ndn::nfd::ControlParameters::getExpirationPeriod ( ) const
inline

Definition at line 354 of file nfd-control-parameters.hpp.

References hasExpirationPeriod().

Referenced by ndn::nfd::operator<<(), and nfd::rib::RibManager::setConfigFile().

§ setExpirationPeriod()

ControlParameters& ndn::nfd::ControlParameters::setExpirationPeriod ( const time::milliseconds &  expirationPeriod)
inline

Definition at line 361 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

§ unsetExpirationPeriod()

ControlParameters& ndn::nfd::ControlParameters::unsetExpirationPeriod ( )
inline

Definition at line 370 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

§ hasFacePersistency()

bool ndn::nfd::ControlParameters::hasFacePersistency ( ) const
inline

Definition at line 378 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

Referenced by ndn::nfd::FaceCreateCommand::applyDefaultsToRequest(), getFacePersistency(), wireDecode(), and wireEncode().

§ getFacePersistency()

FacePersistency ndn::nfd::ControlParameters::getFacePersistency ( ) const
inline

Definition at line 384 of file nfd-control-parameters.hpp.

References hasFacePersistency().

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

§ setFacePersistency()

ControlParameters& ndn::nfd::ControlParameters::setFacePersistency ( FacePersistency  persistency)
inline

Definition at line 391 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

Referenced by ndn::nfd::FaceCreateCommand::applyDefaultsToRequest(), and nfd::FaceManager::setConfigFile().

§ unsetFacePersistency()

ControlParameters& ndn::nfd::ControlParameters::unsetFacePersistency ( )
inline

Definition at line 400 of file nfd-control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

§ getPresentFields()

const std::vector<bool>& ndn::nfd::ControlParameters::getPresentFields ( ) const
inline

Definition at line 408 of file nfd-control-parameters.hpp.

References ndn::nfd::operator<<().

Referenced by ndn::nfd::ControlCommand::FieldValidator::validate().

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