ndn::nfd::ControlParameters Class Reference

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

#include <nfd-control-parameters.hpp>

Inheritance diagram for ndn::nfd::ControlParameters:

Collaboration diagram for ndn::nfd::ControlParameters:

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 ()
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 75 of file nfd-control-parameters.hpp.

Constructor & Destructor Documentation

ndn::nfd::ControlParameters::ControlParameters

(

)

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

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

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

explicit

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

References wireDecode().

Member Function Documentation

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::Flags, hasCost(), hasExpirationPeriod(), hasFaceId(), 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 ndn::nfd::ControlCommand::getRequestName(), nfd::FaceManager::onFaceRequest(), nfd::FibManager::onFibRequest(), nfd::StrategyChoiceManager::onStrategyChoiceRequest(), and nfd::rib::RibManager::setConfigFile().

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

finalvirtual

Implements ndn::mgmt::ControlParameters.

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

References ndn::Block::hasWire().

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

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

finalvirtual

Implements ndn::mgmt::ControlParameters.

Definition at line 115 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_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::Block::find(), ndn::tlv::nfd::Flags, hasCost(), hasExpirationPeriod(), hasFaceId(), 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(), nfd::ManagerBase::extractParameters(), and nfd::rib::RibManager::setConfigFile().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_NAME.

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

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

inline

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

References hasName().

Referenced by nfd::FibManager::onFibRequest(), nfd::StrategyChoiceManager::onStrategyChoiceRequest(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), nfd::rib::RemoteRegistrator::unregisterPrefix(), and ndn::nfd::StrategyChoiceUnsetCommand::validateRequest().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_NAME.

Referenced by nfd::Face::Impl::asyncUnregisterPrefix(), nfd::rib::RemoteRegistrator::registerPrefix(), nfd::Face::Impl::registerPrefix(), nfd::rib::RibManager::setConfigFile(), and nfd::rib::RemoteRegistrator::unregisterPrefix().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_NAME.

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

inline

Definition at line 136 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(), nfd::FibManager::onFibRequest(), ndn::nfd::operator<<(), nfd::rib::RibManager::setConfigFile(), wireDecode(), and wireEncode().

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

inline

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

References hasFaceId().

Referenced by nfd::FaceManager::onFaceRequest(), nfd::FibManager::onFibRequest(), nfd::rib::RibManager::onRibUpdateFailure(), ndn::nfd::operator<<(), 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().

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

inline

Definition at line 149 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(), nfd::rib::RemoteRegistrator::loadConfig(), nfd::FaceManager::onFaceRequest(), nfd::FibManager::onFibRequest(), and nfd::rib::RibManager::setConfigFile().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_URI.

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

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

inline

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

References hasUri().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_URI.

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_URI.

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

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

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

inline

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

References hasLocalControlFeature().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE.

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

inline

Definition at line 226 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().

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

inline

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

References hasOrigin().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

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

inline

Definition at line 256 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().

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

inline

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

References hasCost().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), and nfd::rib::RemoteRegistrator::loadConfig().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by nfd::rib::RemoteRegistrator::unregisterPrefix().

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

inline

Definition at line 286 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().

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

inline

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

References hasFlags().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), and nfd::Face::Impl::registerPrefix().

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

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

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

inline

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

References hasStrategy().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

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

inline

Definition at line 346 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().

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

inline

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

References hasExpirationPeriod().

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

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

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

inline

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

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

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

inline

Definition at line 376 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:

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