Data Structures | Public Member Functions
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:
[legend]
Collaboration diagram for ndn::nfd::ControlParameters:
[legend]

Data Structures

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 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 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 ()
 
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...
 

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

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

LocalControlFeature ndn::nfd::ControlParameters::getLocalControlFeature ( ) const
inline
Deprecated:
use Flags+Mask fields instead

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool ndn::nfd::ControlParameters::hasLocalControlFeature ( ) const
inline
Deprecated:
use Flags+Mask fields instead

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ControlParameters& ndn::nfd::ControlParameters::setLocalControlFeature ( LocalControlFeature  localControlFeature)
inline
Deprecated:
use Flags+Mask fields instead

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ControlParameters& ndn::nfd::ControlParameters::unsetLocalControlFeature ( )
inline
Deprecated:
use Flags+Mask fields instead

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

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

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

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

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

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

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

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

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

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

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

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

Implements ndn::mgmt::ControlParameters.

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

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

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

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

Implements ndn::mgmt::ControlParameters.

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