ndn::nfd::CsInfo Class Reference

Represents the CS Information dataset. More...

#include <ndn-cxx/mgmt/nfd/cs-info.hpp>

Classes

class  Error
 

Public Member Functions

 CsInfo ()
 
 CsInfo (const Block &block)
 
uint64_t getCapacity () const
 Get CS capacity (in number of packets). More...
 
bool getEnableAdmit () const
 Get CS_ENABLE_ADMIT flag. More...
 
bool getEnableServe () const
 Get CS_ENABLE_SERVE flag. More...
 
uint64_t getNEntries () const
 Get number of stored CS entries. More...
 
uint64_t getNHits () const
 Get number of CS lookup hits since NFD started. More...
 
uint64_t getNMisses () const
 Get number of CS lookup misses since NFD started. More...
 
CsInfosetCapacity (uint64_t capacity)
 
CsInfosetEnableAdmit (bool enableAdmit)
 
CsInfosetEnableServe (bool enableServe)
 
CsInfosetNEntries (uint64_t nEntries)
 
CsInfosetNHits (uint64_t nHits)
 
CsInfosetNMisses (uint64_t nMisses)
 
void wireDecode (const Block &wire)
 
const BlockwireEncode () const
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 

Detailed Description

Represents the CS Information dataset.

See also
https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#CS-Information-Dataset

Definition at line 36 of file cs-info.hpp.

Constructor & Destructor Documentation

◆ CsInfo() [1/2]

ndn::nfd::CsInfo::CsInfo ( )
default

◆ CsInfo() [2/2]

ndn::nfd::CsInfo::CsInfo ( const Block block)
explicit

Definition at line 31 of file cs-info.cpp.

Member Function Documentation

◆ getCapacity()

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

Get CS capacity (in number of packets).

Definition at line 63 of file cs-info.hpp.

◆ getEnableAdmit()

bool ndn::nfd::CsInfo::getEnableAdmit ( ) const
inline

Get CS_ENABLE_ADMIT flag.

Definition at line 74 of file cs-info.hpp.

◆ getEnableServe()

bool ndn::nfd::CsInfo::getEnableServe ( ) const
inline

Get CS_ENABLE_SERVE flag.

Definition at line 85 of file cs-info.hpp.

◆ getNEntries()

uint64_t ndn::nfd::CsInfo::getNEntries ( ) const
inline

Get number of stored CS entries.

Definition at line 96 of file cs-info.hpp.

◆ getNHits()

uint64_t ndn::nfd::CsInfo::getNHits ( ) const
inline

Get number of CS lookup hits since NFD started.

Definition at line 107 of file cs-info.hpp.

◆ getNMisses()

uint64_t ndn::nfd::CsInfo::getNMisses ( ) const
inline

Get number of CS lookup misses since NFD started.

Definition at line 118 of file cs-info.hpp.

◆ setCapacity()

CsInfo & ndn::nfd::CsInfo::setCapacity ( uint64_t  capacity)

Definition at line 123 of file cs-info.cpp.

◆ setEnableAdmit()

CsInfo & ndn::nfd::CsInfo::setEnableAdmit ( bool  enableAdmit)

Definition at line 131 of file cs-info.cpp.

◆ setEnableServe()

CsInfo & ndn::nfd::CsInfo::setEnableServe ( bool  enableServe)

Definition at line 139 of file cs-info.cpp.

◆ setNEntries()

CsInfo & ndn::nfd::CsInfo::setNEntries ( uint64_t  nEntries)

Definition at line 147 of file cs-info.cpp.

◆ setNHits()

CsInfo & ndn::nfd::CsInfo::setNHits ( uint64_t  nHits)

Definition at line 155 of file cs-info.cpp.

◆ setNMisses()

CsInfo & ndn::nfd::CsInfo::setNMisses ( uint64_t  nMisses)

Definition at line 163 of file cs-info.cpp.

◆ wireDecode()

void ndn::nfd::CsInfo::wireDecode ( const Block wire)

Definition at line 72 of file cs-info.cpp.

◆ wireEncode() [1/2]

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

Definition at line 56 of file cs-info.cpp.

◆ wireEncode() [2/2]

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

Definition at line 38 of file cs-info.cpp.