NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
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 NamegetName () const
 
ControlParameterssetName (const Name &name)
 
ControlParametersunsetName ()
 
bool hasFaceId () const
 
uint64_t getFaceId () const
 
ControlParameterssetFaceId (uint64_t faceId)
 
ControlParametersunsetFaceId ()
 
bool hasUri () const
 
const std::string & getUri () const
 
ControlParameterssetUri (const std::string &uri)
 
ControlParametersunsetUri ()
 
bool hasLocalControlFeature () const
 
LocalControlFeature getLocalControlFeature () const
 
ControlParameterssetLocalControlFeature (LocalControlFeature localControlFeature)
 
ControlParametersunsetLocalControlFeature ()
 
bool hasOrigin () const
 
uint64_t getOrigin () const
 
ControlParameterssetOrigin (uint64_t origin)
 
ControlParametersunsetOrigin ()
 
bool hasCost () const
 
uint64_t getCost () const
 
ControlParameterssetCost (uint64_t cost)
 
ControlParametersunsetCost ()
 
bool hasFlags () const
 
uint64_t getFlags () const
 
ControlParameterssetFlags (uint64_t flags)
 
ControlParametersunsetFlags ()
 
bool hasStrategy () const
 
const NamegetStrategy () const
 
ControlParameterssetStrategy (const Name &strategy)
 
ControlParametersunsetStrategy ()
 
bool hasExpirationPeriod () const
 
const time::milliseconds & getExpirationPeriod () const
 
ControlParameterssetExpirationPeriod (const time::milliseconds &expirationPeriod)
 
ControlParametersunsetExpirationPeriod ()
 
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 ( )
ndn::nfd::ControlParameters::ControlParameters ( const Block block)
explicit

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

References wireDecode().

Member Function Documentation

Block ndn::nfd::ControlParameters::wireEncode ( ) const
finalvirtual
bool ndn::nfd::ControlParameters::hasName ( ) const
inline
ControlParameters& ndn::nfd::ControlParameters::unsetName ( )
inline

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

References ndn::nfd::CONTROL_PARAMETER_NAME.

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
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
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
LocalControlFeature ndn::nfd::ControlParameters::getLocalControlFeature ( ) const
inline
ControlParameters& ndn::nfd::ControlParameters::setLocalControlFeature ( LocalControlFeature  localControlFeature)
inline
ControlParameters& ndn::nfd::ControlParameters::unsetLocalControlFeature ( )
inline
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::unsetOrigin ( )
inline

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

References ndn::nfd::CONTROL_PARAMETER_ORIGIN.

uint64_t ndn::nfd::ControlParameters::getCost ( ) const
inline
ControlParameters& ndn::nfd::ControlParameters::unsetCost ( )
inline
bool ndn::nfd::ControlParameters::hasFlags ( ) const
inline
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
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
const Name& ndn::nfd::ControlParameters::getStrategy ( ) const
inline
ControlParameters& ndn::nfd::ControlParameters::setStrategy ( const Name strategy)
inline
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
const time::milliseconds& ndn::nfd::ControlParameters::getExpirationPeriod ( ) const
inline
ControlParameters& ndn::nfd::ControlParameters::setExpirationPeriod ( const time::milliseconds &  expirationPeriod)
inline
ControlParameters& ndn::nfd::ControlParameters::unsetExpirationPeriod ( )
inline
const std::vector<bool>& ndn::nfd::ControlParameters::getPresentFields ( ) const
inline

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