NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: 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 <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
 
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 ()
 
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 79 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(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalUri, ndn::tlv::nfd::Mask, 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 ndn::nfd::ControlCommand::getRequestName().

◆ wireEncode() [2/2]

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

Implements ndn::mgmt::ControlParameters.

Definition at line 111 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 127 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_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(), hasName(), hasOrigin(), hasStrategy(), hasUri(), ndn::tlv::nfd::LocalUri, ndn::tlv::nfd::Mask, ndn::tlv::Name, 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().

◆ hasName()

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

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

References hasName().

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

◆ setName()

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

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

References ndn::nfd::CONTROL_PARAMETER_NAME, and ndn::Block::reset().

Referenced by face::Face::Impl::asyncUnregisterPrefix(), and face::Face::Impl::registerPrefix().

◆ unsetName()

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

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

References ndn::nfd::CONTROL_PARAMETER_NAME, and ndn::Block::reset().

◆ hasFaceId()

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

Definition at line 139 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(), and wireEncode().

◆ getFaceId()

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

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

References hasFaceId().

Referenced by ndn::nfd::operator<<(), 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 152 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_FACE_ID, and ndn::Block::reset().

Referenced by ndn::nfd::FaceUpdateCommand::applyDefaultsToRequest(), ndn::nfd::FibAddNextHopCommand::applyDefaultsToRequest(), ndn::nfd::FibRemoveNextHopCommand::applyDefaultsToRequest(), ndn::nfd::RibRegisterCommand::applyDefaultsToRequest(), ndn::nfd::RibUnregisterCommand::applyDefaultsToRequest(), and nfd::rib::AutoPrefixPropagator::loadConfig().

◆ unsetFaceId()

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

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

References ndn::nfd::CONTROL_PARAMETER_FACE_ID, and ndn::Block::reset().

◆ hasUri()

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

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

References hasUri().

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

◆ setUri()

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

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

References ndn::nfd::CONTROL_PARAMETER_URI, and ndn::Block::reset().

◆ unsetUri()

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

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

References ndn::nfd::CONTROL_PARAMETER_URI, and ndn::Block::reset().

◆ hasLocalUri()

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

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI.

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

◆ getLocalUri()

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

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

References hasLocalUri().

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

◆ setLocalUri()

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

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI, and ndn::Block::reset().

◆ unsetLocalUri()

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

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

References ndn::nfd::CONTROL_PARAMETER_LOCAL_URI, and ndn::Block::reset().

◆ hasOrigin()

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

Definition at line 229 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(), and wireEncode().

◆ getOrigin()

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

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

References hasOrigin().

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

◆ setOrigin()

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

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

References ndn::nfd::CONTROL_PARAMETER_ORIGIN, and ndn::Block::reset().

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

◆ unsetOrigin()

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

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

References ndn::nfd::CONTROL_PARAMETER_ORIGIN, and ndn::Block::reset().

◆ hasCost()

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

Definition at line 259 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(), and wireEncode().

◆ getCost()

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

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

References hasCost().

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

◆ setCost()

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

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

References ndn::nfd::CONTROL_PARAMETER_COST, and ndn::Block::reset().

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

◆ unsetCost()

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

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

References ndn::nfd::CONTROL_PARAMETER_COST, and ndn::Block::reset().

◆ hasCapacity()

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

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

References ndn::nfd::CONTROL_PARAMETER_CAPACITY.

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

◆ getCapacity()

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

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

References hasCapacity().

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

◆ setCapacity()

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

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

References ndn::nfd::CONTROL_PARAMETER_CAPACITY, and ndn::Block::reset().

◆ unsetCapacity()

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

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

References ndn::nfd::CONTROL_PARAMETER_CAPACITY, and ndn::Block::reset().

◆ hasCount()

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

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

References ndn::nfd::CONTROL_PARAMETER_COUNT.

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

◆ getCount()

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

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

References hasCount().

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

◆ setCount()

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

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

References ndn::nfd::CONTROL_PARAMETER_COUNT, and ndn::Block::reset().

◆ unsetCount()

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

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

References ndn::nfd::CONTROL_PARAMETER_COUNT, and ndn::Block::reset().

◆ hasFlags()

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

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

References hasFlags().

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

◆ setFlags()

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

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

References ndn::nfd::CONTROL_PARAMETER_FLAGS, and ndn::Block::reset().

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

◆ unsetFlags()

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

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

References ndn::nfd::CONTROL_PARAMETER_FLAGS, and ndn::Block::reset().

Referenced by unsetFlagBit().

◆ hasMask()

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

Definition at line 379 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 385 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 392 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_MASK, and ndn::Block::reset().

Referenced by setFlagBit(), and unsetFlagBit().

◆ unsetMask()

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

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

References ndn::nfd::CONTROL_PARAMETER_MASK, and ndn::Block::reset().

Referenced by unsetFlagBit().

◆ hasStrategy()

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

Definition at line 409 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 415 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 422 of file control-parameters.hpp.

References ndn::nfd::CONTROL_PARAMETER_STRATEGY, and ndn::Block::reset().

◆ unsetStrategy()

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

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

References ndn::nfd::CONTROL_PARAMETER_STRATEGY, and ndn::Block::reset().

◆ hasExpirationPeriod()

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

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

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD.

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

◆ getExpirationPeriod()

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

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

References hasExpirationPeriod().

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

◆ setExpirationPeriod()

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

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

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD, and ndn::Block::reset().

◆ unsetExpirationPeriod()

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

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

References ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD, and ndn::Block::reset().

◆ hasFacePersistency()

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

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

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY.

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

◆ getFacePersistency()

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

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

References hasFacePersistency().

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

◆ setFacePersistency()

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

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

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY, and ndn::Block::reset().

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

◆ unsetFacePersistency()

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

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

References ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY, and ndn::Block::reset().

◆ hasBaseCongestionMarkingInterval()

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

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

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL.

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

◆ getBaseCongestionMarkingInterval()

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

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

References hasBaseCongestionMarkingInterval().

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

◆ setBaseCongestionMarkingInterval()

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

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

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL, and ndn::Block::reset().

◆ unsetBaseCongestionMarkingInterval()

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

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

References ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL, and ndn::Block::reset().

◆ hasDefaultCongestionThreshold()

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

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

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD.

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

◆ getDefaultCongestionThreshold()

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

get default congestion threshold (measured in bytes)

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

References hasDefaultCongestionThreshold().

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

◆ setDefaultCongestionThreshold()

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

set default congestion threshold (measured in bytes)

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

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD, and ndn::Block::reset().

◆ unsetDefaultCongestionThreshold()

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

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

References ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD, and ndn::Block::reset().

◆ getPresentFields()

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

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

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
bitbit position within range [0, 64) (least significant bit is 0)

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

References getMask(), and hasMask().

◆ getFlagBit()

bool ndn::nfd::ControlParameters::getFlagBit ( size_t  bit) const
Returns
bit at a position in Flags
Parameters
bitbit position within range [0, 64) (least significant bit is 0)

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

References getFlags(), and hasFlags().

◆ setFlagBit()

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

set a bit in Flags

Parameters
bitbit position within range [0, 64) (least significant bit is 0)
valuenew value in Flags
wantMaskif true, enable the bit in Mask

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

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

◆ unsetFlagBit()

ControlParameters & ndn::nfd::ControlParameters::unsetFlagBit ( size_t  bit)

disable a bit in Mask

Parameters
bitbit 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 287 of file control-parameters.cpp.

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

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