ndn::nfd::ControlParameters Class Reference

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

#include <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
Block	wireEncode () const final
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	hasLocalUri () const
const std::string &	getLocalUri () const
ControlParameters &	setLocalUri (const std::string &localUri)
ControlParameters &	unsetLocalUri ()
bool	hasOrigin () const
RouteOrigin	getOrigin () const
ControlParameters &	setOrigin (RouteOrigin origin)
ControlParameters &	unsetOrigin ()
bool	hasCost () const
uint64_t	getCost () const
ControlParameters &	setCost (uint64_t cost)
ControlParameters &	unsetCost ()
bool	hasCapacity () const
uint64_t	getCapacity () const
ControlParameters &	setCapacity (uint64_t capacity)
ControlParameters &	unsetCapacity ()
bool	hasCount () const
uint64_t	getCount () const
ControlParameters &	setCount (uint64_t count)
ControlParameters &	unsetCount ()
bool	hasFlags () const
uint64_t	getFlags () const
ControlParameters &	setFlags (uint64_t flags)
ControlParameters &	unsetFlags ()
bool	hasMask () const
uint64_t	getMask () const
ControlParameters &	setMask (uint64_t mask)
ControlParameters &	unsetMask ()
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 ()
bool	hasBaseCongestionMarkingInterval () const
time::nanoseconds	getBaseCongestionMarkingInterval () const
ControlParameters &	setBaseCongestionMarkingInterval (time::nanoseconds interval)
ControlParameters &	unsetBaseCongestionMarkingInterval ()
bool	hasDefaultCongestionThreshold () const
uint64_t	getDefaultCongestionThreshold () const
	get default congestion threshold (measured in bytes) More...
ControlParameters &	setDefaultCongestionThreshold (uint64_t threshold)
	set default congestion threshold (measured in bytes) More...
ControlParameters &	unsetDefaultCongestionThreshold ()
bool	hasMtu () const
uint64_t	getMtu () const
	get MTU (measured in bytes) More...
ControlParameters &	setMtu (uint64_t mtu)
	set MTU (measured in bytes) More...
ControlParameters &	unsetMtu ()
const std::vector< bool > &	getPresentFields () const
bool	hasFlagBit (size_t bit) const
bool	getFlagBit (size_t bit) const
ControlParameters &	setFlagBit (size_t bit, bool value, bool wantMask=true)
	set a bit in Flags More...
ControlParameters &	unsetFlagBit (size_t bit)
	disable a bit in Mask More...
Public Member Functions inherited from ndn::mgmt::ControlParameters
virtual	~ControlParameters ()=default

Detailed Description

represents parameters in a ControlCommand request or response

See also

https://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 81 of file control-parameters.hpp.

Constructor & Destructor Documentation

ControlParameters() [1/2]

ndn::nfd::ControlParameters::ControlParameters

(

)

Definition at line 37 of file control-parameters.cpp.

ControlParameters() [2/2]

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

explicit

Definition at line 42 of file 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 50 of file control-parameters.cpp.

References ndn::tlv::nfd::BaseCongestionMarkingInterval, ndn::tlv::nfd::Capacity, ndn::tlv::nfd::ControlParameters, ndn::tlv::nfd::Cost, ndn::tlv::nfd::Count, ndn::tlv::nfd::DefaultCongestionThreshold, ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::Flags, hasBaseCongestionMarkingInterval(), hasCapacity(), hasCost(), hasCount(), hasDefaultCongestionThreshold(), hasExpirationPeriod(), hasFaceId(), hasFacePersistency(), hasFlags(), hasLocalUri(), hasMask(), hasMtu(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalUri, ndn::tlv::nfd::Mask, ndn::tlv::nfd::Mtu, ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::tlv::nfd::Origin, ndn::encoding::prependNestedBlock(), ndn::encoding::prependNonNegativeIntegerBlock(), ndn::encoding::prependStringBlock(), ndn::tlv::nfd::Strategy, ndn::tlv::nfd::Uri, and ndn::Name::wireEncode().

Referenced by nfd::CsManager::CsManager(), nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), ndn::nfd::ControlCommand::getRequestName(), nfd::makeCreateFaceResponse(), nfd::updateLinkServiceOptions(), and ndn::util::DummyClientFace::~DummyClientFace().

wireEncode() [2/2]

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

finalvirtual

Implements ndn::mgmt::ControlParameters.

Definition at line 114 of file control-parameters.cpp.

References ndn::Block::hasWire().

wireDecode()

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

finalvirtual

Implements ndn::mgmt::ControlParameters.

Definition at line 130 of file control-parameters.cpp.

References ndn::tlv::nfd::BaseCongestionMarkingInterval, ndn::tlv::nfd::Capacity, ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL, ndn::nfd::CONTROL_PARAMETER_CAPACITY, ndn::nfd::CONTROL_PARAMETER_COST, ndn::nfd::CONTROL_PARAMETER_COUNT, ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD, 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_URI, ndn::nfd::CONTROL_PARAMETER_MASK, ndn::nfd::CONTROL_PARAMETER_MTU, 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::tlv::nfd::Count, ndn::tlv::nfd::DefaultCongestionThreshold, ndn::Block::elements_end(), ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::Block::find(), ndn::tlv::nfd::Flags, hasBaseCongestionMarkingInterval(), hasCapacity(), hasCost(), hasCount(), hasDefaultCongestionThreshold(), hasExpirationPeriod(), hasFaceId(), hasFacePersistency(), hasFlags(), hasLocalUri(), hasMask(), hasMtu(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalUri, ndn::tlv::nfd::Mask, ndn::tlv::nfd::Mtu, ndn::tlv::Name, NDN_THROW, ndn::tlv::nfd::Origin, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::tlv::nfd::Strategy, ndn::Block::type(), ndn::tlv::nfd::Uri, and ndn::Name::wireDecode().

Referenced by ControlParameters(), and ndn::nfd::Controller::~Controller().

hasName()

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

inline

Definition at line 107 of file 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 113 of file control-parameters.hpp.

References hasName().

Referenced by nfd::CsManager::CsManager(), nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), ndn::nfd::operator<<(), and ndn::nfd::StrategyChoiceUnsetCommand::validateRequest().

setName()

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

inline

Definition at line 120 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_NAME.

Referenced by nfd::rib::NfdRibReadvertiseDestination::advertise(), nfd::CsManager::CsManager(), and nfd::rib::NfdRibReadvertiseDestination::withdraw().

unsetName()

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

inline

Definition at line 129 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_NAME.

hasFaceId()

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

inline

Definition at line 137 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

Referenced by ndn::nfd::FaceUpdateCommand::applyDefaultsToRequest(), ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::FibRemoveNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), getFaceId(), ndn::nfd::operator<<(), wireDecode(), wireEncode(), and ndn::util::DummyClientFace::~DummyClientFace().

getFaceId()

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

inline

Definition at line 143 of file control-parameters.hpp.

References hasFaceId().

Referenced by nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), ndn::nfd::operator<<(), nfd::updateLinkServiceOptions(), ndn::nfd::FaceDestroyCommand::validateRequest(), ndn::nfd::FaceCreateCommand::validateResponse(), ndn::nfd::FaceUpdateCommand::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 150 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

Referenced by ndn::nfd::FaceUpdateCommand::applyDefaultsToRequest(), ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::FibRemoveNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), nfd::makeUpdateFaceResponse(), and ndn::util::DummyClientFace::~DummyClientFace().

unsetFaceId()

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

inline

Definition at line 159 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID.

hasUri()

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

inline

Definition at line 167 of file 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 173 of file control-parameters.hpp.

References hasUri().

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

setUri()

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

inline

Definition at line 180 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_URI.

Referenced by nfd::makeCreateFaceResponse().

unsetUri()

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

inline

Definition at line 189 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_URI.

hasLocalUri()

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

inline

Definition at line 197 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI.

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

getLocalUri()

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

inline

Definition at line 203 of file control-parameters.hpp.

References hasLocalUri().

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

setLocalUri()

ControlParameters& ndn::nfd::ControlParameters::setLocalUri ( const std::string &  localUri )

inline

Definition at line 210 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI.

unsetLocalUri()

ControlParameters& ndn::nfd::ControlParameters::unsetLocalUri ( )

inline

Definition at line 219 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI.

hasOrigin()

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

inline

Definition at line 227 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), getOrigin(), ndn::nfd::operator<<(), wireDecode(), wireEncode(), and ndn::util::DummyClientFace::~DummyClientFace().

getOrigin()

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

inline

Definition at line 233 of file control-parameters.hpp.

References hasOrigin().

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

setOrigin()

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

inline

Definition at line 240 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), and ndn::util::DummyClientFace::~DummyClientFace().

unsetOrigin()

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

inline

Definition at line 249 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

hasCost()

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

inline

Definition at line 257 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

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

getCost()

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

inline

Definition at line 263 of file control-parameters.hpp.

References hasCost().

Referenced by nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), and ndn::nfd::operator<<().

setCost()

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

inline

Definition at line 270 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

Referenced by ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), and ndn::util::DummyClientFace::~DummyClientFace().

unsetCost()

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

inline

Definition at line 279 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COST.

hasCapacity()

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

inline

Definition at line 287 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_CAPACITY.

Referenced by nfd::CsManager::CsManager(), getCapacity(), ndn::nfd::operator<<(), ndn::nfd::CsEraseCommand::validateResponse(), wireDecode(), and wireEncode().

getCapacity()

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

inline

Definition at line 293 of file control-parameters.hpp.

References hasCapacity().

Referenced by nfd::CsManager::CsManager(), ndn::nfd::operator<<(), and ndn::nfd::CsEraseCommand::validateResponse().

setCapacity()

ControlParameters& ndn::nfd::ControlParameters::setCapacity ( uint64_t  capacity )

inline

Definition at line 300 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_CAPACITY.

Referenced by nfd::CsManager::CsManager().

unsetCapacity()

ControlParameters& ndn::nfd::ControlParameters::unsetCapacity ( )

inline

Definition at line 309 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_CAPACITY.

hasCount()

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

inline

Definition at line 317 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COUNT.

Referenced by nfd::CsManager::CsManager(), getCount(), ndn::nfd::operator<<(), ndn::nfd::CsEraseCommand::validateRequest(), wireDecode(), and wireEncode().

getCount()

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

inline

Definition at line 323 of file control-parameters.hpp.

References hasCount().

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

setCount()

ControlParameters& ndn::nfd::ControlParameters::setCount ( uint64_t  count )

inline

Definition at line 330 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COUNT.

Referenced by nfd::CsManager::CsManager().

unsetCount()

ControlParameters& ndn::nfd::ControlParameters::unsetCount ( )

inline

Definition at line 339 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_COUNT.

hasFlags()

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

inline

Definition at line 347 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), getFlagBit(), getFlags(), ndn::nfd::operator<<(), setFlagBit(), ndn::nfd::ControlCommand::FieldValidator::validate(), wireDecode(), and wireEncode().

getFlags()

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

inline

Definition at line 353 of file control-parameters.hpp.

References hasFlags().

Referenced by nfd::RibManager::enableLocalFields(), getFlagBit(), ndn::nfd::operator<<(), and setFlagBit().

setFlags()

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

inline

Definition at line 360 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), and setFlagBit().

unsetFlags()

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

inline

Definition at line 369 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FLAGS.

Referenced by unsetFlagBit().

hasMask()

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

inline

Definition at line 377 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MASK.

Referenced by getMask(), hasFlagBit(), ndn::nfd::operator<<(), setFlagBit(), unsetFlagBit(), ndn::nfd::ControlCommand::FieldValidator::validate(), wireDecode(), and wireEncode().

getMask()

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

inline

Definition at line 383 of file control-parameters.hpp.

References hasMask().

Referenced by hasFlagBit(), ndn::nfd::operator<<(), setFlagBit(), and unsetFlagBit().

setMask()

ControlParameters& ndn::nfd::ControlParameters::setMask ( uint64_t  mask )

inline

Definition at line 390 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MASK.

Referenced by setFlagBit(), and unsetFlagBit().

unsetMask()

ControlParameters& ndn::nfd::ControlParameters::unsetMask ( )

inline

Definition at line 399 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MASK.

Referenced by unsetFlagBit().

hasStrategy()

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

inline

Definition at line 407 of file 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 413 of file control-parameters.hpp.

References hasStrategy().

Referenced by ndn::nfd::operator<<().

setStrategy()

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

inline

Definition at line 420 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

unsetStrategy()

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

inline

Definition at line 429 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY.

hasExpirationPeriod()

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

inline

Definition at line 437 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

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

getExpirationPeriod()

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

inline

Definition at line 443 of file control-parameters.hpp.

References hasExpirationPeriod().

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

setExpirationPeriod()

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

inline

Definition at line 450 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

unsetExpirationPeriod()

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

inline

Definition at line 459 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

hasFacePersistency()

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

inline

Definition at line 467 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

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

getFacePersistency()

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

inline

Definition at line 473 of file control-parameters.hpp.

References hasFacePersistency().

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

setFacePersistency()

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

inline

Definition at line 480 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

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

unsetFacePersistency()

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

inline

Definition at line 489 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

hasBaseCongestionMarkingInterval()

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

inline

Definition at line 497 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL.

Referenced by nfd::FaceManager::FaceManager(), getBaseCongestionMarkingInterval(), ndn::nfd::operator<<(), nfd::updateLinkServiceOptions(), wireDecode(), and wireEncode().

getBaseCongestionMarkingInterval()

time::nanoseconds ndn::nfd::ControlParameters::getBaseCongestionMarkingInterval ( ) const

inline

Definition at line 503 of file control-parameters.hpp.

References hasBaseCongestionMarkingInterval().

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

setBaseCongestionMarkingInterval()

ControlParameters& ndn::nfd::ControlParameters::setBaseCongestionMarkingInterval ( time::nanoseconds  interval )

inline

Definition at line 510 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL.

Referenced by nfd::makeUpdateFaceResponse().

unsetBaseCongestionMarkingInterval()

ControlParameters& ndn::nfd::ControlParameters::unsetBaseCongestionMarkingInterval ( )

inline

Definition at line 519 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL.

hasDefaultCongestionThreshold()

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

inline

Definition at line 527 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD.

Referenced by nfd::FaceManager::FaceManager(), getDefaultCongestionThreshold(), ndn::nfd::operator<<(), nfd::updateLinkServiceOptions(), wireDecode(), and wireEncode().

getDefaultCongestionThreshold()

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

inline

get default congestion threshold (measured in bytes)

Definition at line 535 of file control-parameters.hpp.

References hasDefaultCongestionThreshold().

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

setDefaultCongestionThreshold()

ControlParameters& ndn::nfd::ControlParameters::setDefaultCongestionThreshold ( uint64_t  threshold )

inline

set default congestion threshold (measured in bytes)

Definition at line 544 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD.

Referenced by nfd::makeUpdateFaceResponse().

unsetDefaultCongestionThreshold()

ControlParameters& ndn::nfd::ControlParameters::unsetDefaultCongestionThreshold ( )

inline

Definition at line 553 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD.

hasMtu()

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

inline

Definition at line 561 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MTU.

Referenced by nfd::FaceManager::FaceManager(), getMtu(), ndn::nfd::operator<<(), nfd::updateLinkServiceOptions(), wireDecode(), and wireEncode().

getMtu()

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

inline

get MTU (measured in bytes)

This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.

Definition at line 571 of file control-parameters.hpp.

References hasMtu().

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

setMtu()

ControlParameters& ndn::nfd::ControlParameters::setMtu ( uint64_t  mtu )

inline

set MTU (measured in bytes)

This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.

Definition at line 582 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MTU.

Referenced by nfd::updateLinkServiceOptions().

unsetMtu()

ControlParameters& ndn::nfd::ControlParameters::unsetMtu ( )

inline

Definition at line 591 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MTU.

getPresentFields()

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

inline

Definition at line 599 of file control-parameters.hpp.

References getFlagBit(), hasFlagBit(), ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(), ndn::nfd::operator<<(), setFlagBit(), and unsetFlagBit().

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

hasFlagBit()

bool ndn::nfd::ControlParameters::hasFlagBit

(

size_t

bit

)

const

Returns

whether bit is enabled in Mask

Parameters

bit	bit position within range [0, 64) (least significant bit is 0)

Definition at line 244 of file control-parameters.cpp.

References getMask(), hasMask(), and NDN_THROW.

Referenced by nfd::CsManager::CsManager(), nfd::FaceManager::FaceManager(), getPresentFields(), nfd::makeCreateFaceResponse(), and nfd::updateLinkServiceOptions().

getFlagBit()

bool ndn::nfd::ControlParameters::getFlagBit

(

size_t

bit

)

const

Returns

bit at a position in Flags

Parameters

bit	bit position within range [0, 64) (least significant bit is 0)

Definition at line 258 of file control-parameters.cpp.

References getFlags(), hasFlags(), and NDN_THROW.

Referenced by nfd::CsManager::CsManager(), nfd::FaceManager::FaceManager(), getPresentFields(), nfd::makeCreateFaceResponse(), and nfd::updateLinkServiceOptions().

setFlagBit()

ControlParameters & ndn::nfd::ControlParameters::setFlagBit	(	size_t	bit,
		bool	value,
		bool	wantMask = true
	)

set a bit in Flags

Parameters

bit	bit position within range [0, 64) (least significant bit is 0)
value	new value in Flags
wantMask	if true, enable the bit in Mask

Definition at line 272 of file control-parameters.cpp.

References getFlags(), getMask(), hasFlags(), hasMask(), NDN_THROW, setFlags(), and setMask().

Referenced by nfd::CsManager::CsManager(), getPresentFields(), nfd::makeUpdateFaceResponse(), and nfd::updateLinkServiceOptions().

unsetFlagBit()

ControlParameters & ndn::nfd::ControlParameters::unsetFlagBit

(

size_t

bit

)

disable a bit in Mask

Parameters

bit	bit position within range [0, 64) (least significant bit is 0)

Postcondition

If all bits are disabled, Flags and Mask fields are deleted.

Definition at line 297 of file control-parameters.cpp.

References getMask(), hasMask(), NDN_THROW, setMask(), unsetFlags(), and unsetMask().

Referenced by getPresentFields().

---

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

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