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:
+ Collaboration diagram for ndn::nfd::ControlParameters:

Classes

class  Error
 

Public Member Functions

 ControlParameters ()
 
 ControlParameters (const Block &block)
 
time::nanoseconds getBaseCongestionMarkingInterval () const
 
uint64_t getCapacity () const
 
uint64_t getCost () const
 
uint64_t getCount () const
 
uint64_t getDefaultCongestionThreshold () const
 get default congestion threshold (measured in bytes) More...
 
const time::milliseconds & getExpirationPeriod () const
 
uint64_t getFaceId () const
 
FacePersistency getFacePersistency () const
 
bool getFlagBit (size_t bit) const
 
uint64_t getFlags () const
 
const std::string & getLocalUri () const
 
uint64_t getMask () const
 
const Name & getName () const
 
RouteOrigin getOrigin () const
 
const std::vector< bool > & getPresentFields () const
 
const Name & getStrategy () const
 
const std::string & getUri () const
 
bool hasBaseCongestionMarkingInterval () const
 
bool hasCapacity () const
 
bool hasCost () const
 
bool hasCount () const
 
bool hasDefaultCongestionThreshold () const
 
bool hasExpirationPeriod () const
 
bool hasFaceId () const
 
bool hasFacePersistency () const
 
bool hasFlagBit (size_t bit) const
 
bool hasFlags () const
 
bool hasLocalUri () const
 
bool hasMask () const
 
bool hasName () const
 
bool hasOrigin () const
 
bool hasStrategy () const
 
bool hasUri () const
 
ControlParameters & setBaseCongestionMarkingInterval (time::nanoseconds interval)
 
ControlParameters & setCapacity (uint64_t capacity)
 
ControlParameters & setCost (uint64_t cost)
 
ControlParameters & setCount (uint64_t count)
 
ControlParameters & setDefaultCongestionThreshold (uint64_t threshold)
 set default congestion threshold (measured in bytes) More...
 
ControlParameters & setExpirationPeriod (const time::milliseconds &expirationPeriod)
 
ControlParameters & setFaceId (uint64_t faceId)
 
ControlParameters & setFacePersistency (FacePersistency persistency)
 
ControlParameters & setFlagBit (size_t bit, bool value, bool wantMask=true)
 set a bit in Flags More...
 
ControlParameters & setFlags (uint64_t flags)
 
ControlParameters & setLocalUri (const std::string &localUri)
 
ControlParameters & setMask (uint64_t mask)
 
ControlParameters & setName (const Name &name)
 
ControlParameters & setOrigin (RouteOrigin origin)
 
ControlParameters & setStrategy (const Name &strategy)
 
ControlParameters & setUri (const std::string &uri)
 
ControlParameters & unsetBaseCongestionMarkingInterval ()
 
ControlParameters & unsetCapacity ()
 
ControlParameters & unsetCost ()
 
ControlParameters & unsetCount ()
 
ControlParameters & unsetDefaultCongestionThreshold ()
 
ControlParameters & unsetExpirationPeriod ()
 
ControlParameters & unsetFaceId ()
 
ControlParameters & unsetFacePersistency ()
 
ControlParameters & unsetFlagBit (size_t bit)
 disable a bit in Mask More...
 
ControlParameters & unsetFlags ()
 
ControlParameters & unsetLocalUri ()
 
ControlParameters & unsetMask ()
 
ControlParameters & unsetName ()
 
ControlParameters & unsetOrigin ()
 
ControlParameters & unsetStrategy ()
 
ControlParameters & unsetUri ()
 
void wireDecode (const Block &wire) final
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 
Block wireEncode () const final
 

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 nfd/control-parameters.hpp.

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

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

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

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

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

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

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

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

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

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

get default congestion threshold (measured in bytes)

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

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

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

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

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

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

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

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.

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

Definition at line 355 of file nfd/control-parameters.hpp.

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

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

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

Definition at line 385 of file nfd/control-parameters.hpp.

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

Definition at line 115 of file nfd/control-parameters.hpp.

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

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

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

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

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

Definition at line 415 of file nfd/control-parameters.hpp.

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

Definition at line 175 of file nfd/control-parameters.hpp.

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

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

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

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

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

Definition at line 259 of file nfd/control-parameters.hpp.

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

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

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

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

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

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

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

Definition at line 139 of file nfd/control-parameters.hpp.

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

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

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.

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

Definition at line 349 of file nfd/control-parameters.hpp.

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

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

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

Definition at line 379 of file nfd/control-parameters.hpp.

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

Definition at line 109 of file nfd/control-parameters.hpp.

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

Definition at line 229 of file nfd/control-parameters.hpp.

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

Definition at line 409 of file nfd/control-parameters.hpp.

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

Definition at line 169 of file nfd/control-parameters.hpp.

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

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

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

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

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

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

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

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

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

set default congestion threshold (measured in bytes)

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

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

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

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

Definition at line 152 of file nfd/control-parameters.hpp.

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

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

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.

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

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

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

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

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

Definition at line 392 of file nfd/control-parameters.hpp.

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

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

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

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

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

Definition at line 422 of file nfd/control-parameters.hpp.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Implements ndn::mgmt::ControlParameters.

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

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

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

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

Implements ndn::mgmt::ControlParameters.

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