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::ForwarderStatus Class Reference
Management

represents NFD General Status dataset More...

#include <forwarder-status.hpp>

Classes

class  Error
 

Public Member Functions

 ForwarderStatus ()
 
 ForwarderStatus (const Block &payload)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 prepend ForwarderStatus as a Content block to the encoder More...
 
const Block & wireEncode () const
 encode ForwarderStatus as a Content block More...
 
void wireDecode (const Block &wire)
 decode ForwarderStatus from a Content block More...
 
const std::string & getNfdVersion () const
 
ForwarderStatus & setNfdVersion (const std::string &nfdVersion)
 
const time::system_clock::TimePoint & getStartTimestamp () const
 
ForwarderStatus & setStartTimestamp (const time::system_clock::TimePoint &startTimestamp)
 
const time::system_clock::TimePoint & getCurrentTimestamp () const
 
ForwarderStatus & setCurrentTimestamp (const time::system_clock::TimePoint &currentTimestamp)
 
uint64_t getNNameTreeEntries () const
 
ForwarderStatus & setNNameTreeEntries (uint64_t nNameTreeEntries)
 
uint64_t getNFibEntries () const
 
ForwarderStatus & setNFibEntries (uint64_t nFibEntries)
 
uint64_t getNPitEntries () const
 
ForwarderStatus & setNPitEntries (uint64_t nPitEntries)
 
uint64_t getNMeasurementsEntries () const
 
ForwarderStatus & setNMeasurementsEntries (uint64_t nMeasurementsEntries)
 
uint64_t getNCsEntries () const
 
ForwarderStatus & setNCsEntries (uint64_t nCsEntries)
 
uint64_t getNInInterests () const
 
ForwarderStatus & setNInInterests (uint64_t nInInterests)
 
uint64_t getNInData () const
 
ForwarderStatus & setNInData (uint64_t nInData)
 
uint64_t getNInNacks () const
 
ForwarderStatus & setNInNacks (uint64_t nInNacks)
 
uint64_t getNOutInterests () const
 
ForwarderStatus & setNOutInterests (uint64_t nOutInterests)
 
uint64_t getNOutData () const
 
ForwarderStatus & setNOutData (uint64_t nOutData)
 
uint64_t getNOutNacks () const
 
ForwarderStatus & setNOutNacks (uint64_t nOutNacks)
 
uint64_t getNSatisfiedInterests () const
 
ForwarderStatus & setNSatisfiedInterests (uint64_t nSatisfiedInterests)
 
uint64_t getNUnsatisfiedInterests () const
 
ForwarderStatus & setNUnsatisfiedInterests (uint64_t nUnsatisfiedInterests)
 

Detailed Description

represents NFD General Status dataset

See also
https://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus#General-Status-Dataset

Definition at line 36 of file forwarder-status.hpp.

Constructor & Destructor Documentation

◆ ForwarderStatus() [1/2]

ndn::nfd::ForwarderStatus::ForwarderStatus ( )

Definition at line 33 of file forwarder-status.cpp.

◆ ForwarderStatus() [2/2]

ndn::nfd::ForwarderStatus::ForwarderStatus ( const Block &  payload)
explicit

Definition at line 50 of file forwarder-status.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

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

prepend ForwarderStatus as a Content block to the encoder

The outermost Content element isn't part of ForwarderStatus structure.

Definition at line 57 of file forwarder-status.cpp.

References ndn::tlv::Content, ndn::tlv::nfd::CurrentTimestamp, ndn::tlv::nfd::NCsEntries, ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::tlv::nfd::NfdVersion, ndn::tlv::nfd::NFibEntries, ndn::tlv::nfd::NInData, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NMeasurementsEntries, ndn::tlv::nfd::NNameTreeEntries, ndn::tlv::nfd::NOutData, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, ndn::tlv::nfd::NPitEntries, ndn::tlv::nfd::NSatisfiedInterests, ndn::tlv::nfd::NUnsatisfiedInterests, ndn::encoding::prependNonNegativeIntegerBlock(), ndn::encoding::prependStringBlock(), ndn::tlv::nfd::StartTimestamp, and ndn::time::toUnixTimestamp().

◆ wireEncode() [2/2]

const Block & ndn::nfd::ForwarderStatus::wireEncode ( ) const

encode ForwarderStatus as a Content block

The outermost Content element isn't part of ForwarderStatus structure.

Definition at line 88 of file forwarder-status.cpp.

References ndn::Block::hasWire().

◆ wireDecode()

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

decode ForwarderStatus from a Content block

The outermost Content element isn't part of ForwarderStatus structure.

Definition at line 104 of file forwarder-status.cpp.

References ndn::tlv::Content, ndn::tlv::nfd::CurrentTimestamp, ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::time::fromUnixTimestamp(), ndn::tlv::nfd::NCsEntries, NDN_THROW, ndn::tlv::nfd::NfdVersion, ndn::tlv::nfd::NFibEntries, ndn::tlv::nfd::NInData, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NMeasurementsEntries, ndn::tlv::nfd::NNameTreeEntries, ndn::tlv::nfd::NOutData, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, ndn::tlv::nfd::NPitEntries, ndn::tlv::nfd::NSatisfiedInterests, ndn::tlv::nfd::NUnsatisfiedInterests, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::tlv::nfd::StartTimestamp, and ndn::Block::type().

Referenced by ForwarderStatus().

◆ getNfdVersion()

const std::string& ndn::nfd::ForwarderStatus::getNfdVersion ( ) const
inline

Definition at line 74 of file forwarder-status.hpp.

References setNfdVersion().

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

◆ setNfdVersion()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNfdVersion ( const std::string &  nfdVersion)

Definition at line 244 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNfdVersion().

◆ getStartTimestamp()

const time::system_clock::TimePoint& ndn::nfd::ForwarderStatus::getStartTimestamp ( ) const
inline

Definition at line 83 of file forwarder-status.hpp.

References setStartTimestamp().

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

◆ setStartTimestamp()

ForwarderStatus & ndn::nfd::ForwarderStatus::setStartTimestamp ( const time::system_clock::TimePoint &  startTimestamp)

Definition at line 252 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getStartTimestamp().

◆ getCurrentTimestamp()

const time::system_clock::TimePoint& ndn::nfd::ForwarderStatus::getCurrentTimestamp ( ) const
inline

Definition at line 92 of file forwarder-status.hpp.

References setCurrentTimestamp().

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

◆ setCurrentTimestamp()

ForwarderStatus & ndn::nfd::ForwarderStatus::setCurrentTimestamp ( const time::system_clock::TimePoint &  currentTimestamp)

Definition at line 260 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getCurrentTimestamp().

◆ getNNameTreeEntries()

uint64_t ndn::nfd::ForwarderStatus::getNNameTreeEntries ( ) const
inline

Definition at line 101 of file forwarder-status.hpp.

References setNNameTreeEntries().

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

◆ setNNameTreeEntries()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNNameTreeEntries ( uint64_t  nNameTreeEntries)

Definition at line 268 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNNameTreeEntries().

◆ getNFibEntries()

uint64_t ndn::nfd::ForwarderStatus::getNFibEntries ( ) const
inline

Definition at line 110 of file forwarder-status.hpp.

References setNFibEntries().

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

◆ setNFibEntries()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNFibEntries ( uint64_t  nFibEntries)

Definition at line 276 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNFibEntries().

◆ getNPitEntries()

uint64_t ndn::nfd::ForwarderStatus::getNPitEntries ( ) const
inline

Definition at line 119 of file forwarder-status.hpp.

References setNPitEntries().

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

◆ setNPitEntries()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNPitEntries ( uint64_t  nPitEntries)

Definition at line 284 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNPitEntries().

◆ getNMeasurementsEntries()

uint64_t ndn::nfd::ForwarderStatus::getNMeasurementsEntries ( ) const
inline

Definition at line 128 of file forwarder-status.hpp.

References setNMeasurementsEntries().

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

◆ setNMeasurementsEntries()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNMeasurementsEntries ( uint64_t  nMeasurementsEntries)

Definition at line 292 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNMeasurementsEntries().

◆ getNCsEntries()

uint64_t ndn::nfd::ForwarderStatus::getNCsEntries ( ) const
inline

Definition at line 137 of file forwarder-status.hpp.

References setNCsEntries().

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

◆ setNCsEntries()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNCsEntries ( uint64_t  nCsEntries)

Definition at line 300 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNCsEntries().

◆ getNInInterests()

uint64_t ndn::nfd::ForwarderStatus::getNInInterests ( ) const
inline

Definition at line 146 of file forwarder-status.hpp.

References setNInInterests().

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

◆ setNInInterests()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNInInterests ( uint64_t  nInInterests)

Definition at line 308 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNInInterests().

◆ getNInData()

uint64_t ndn::nfd::ForwarderStatus::getNInData ( ) const
inline

Definition at line 155 of file forwarder-status.hpp.

References setNInData().

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

◆ setNInData()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNInData ( uint64_t  nInData)

Definition at line 316 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNInData().

◆ getNInNacks()

uint64_t ndn::nfd::ForwarderStatus::getNInNacks ( ) const
inline

Definition at line 164 of file forwarder-status.hpp.

References setNInNacks().

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

◆ setNInNacks()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNInNacks ( uint64_t  nInNacks)

Definition at line 324 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNInNacks().

◆ getNOutInterests()

uint64_t ndn::nfd::ForwarderStatus::getNOutInterests ( ) const
inline

Definition at line 173 of file forwarder-status.hpp.

References setNOutInterests().

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

◆ setNOutInterests()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNOutInterests ( uint64_t  nOutInterests)

Definition at line 332 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNOutInterests().

◆ getNOutData()

uint64_t ndn::nfd::ForwarderStatus::getNOutData ( ) const
inline

Definition at line 182 of file forwarder-status.hpp.

References setNOutData().

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

◆ setNOutData()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNOutData ( uint64_t  nOutData)

Definition at line 340 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNOutData().

◆ getNOutNacks()

uint64_t ndn::nfd::ForwarderStatus::getNOutNacks ( ) const
inline

Definition at line 191 of file forwarder-status.hpp.

References setNOutNacks().

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

◆ setNOutNacks()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNOutNacks ( uint64_t  nOutNacks)

Definition at line 348 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNOutNacks().

◆ getNSatisfiedInterests()

uint64_t ndn::nfd::ForwarderStatus::getNSatisfiedInterests ( ) const
inline

Definition at line 200 of file forwarder-status.hpp.

References setNSatisfiedInterests().

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

◆ setNSatisfiedInterests()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNSatisfiedInterests ( uint64_t  nSatisfiedInterests)

Definition at line 356 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNSatisfiedInterests().

◆ getNUnsatisfiedInterests()

uint64_t ndn::nfd::ForwarderStatus::getNUnsatisfiedInterests ( ) const
inline

Definition at line 209 of file forwarder-status.hpp.

References ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(), ndn::nfd::operator==(), and setNUnsatisfiedInterests().

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

◆ setNUnsatisfiedInterests()

ForwarderStatus & ndn::nfd::ForwarderStatus::setNUnsatisfiedInterests ( uint64_t  nUnsatisfiedInterests)

Definition at line 364 of file forwarder-status.cpp.

References ndn::Block::reset().

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and getNUnsatisfiedInterests().

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