Classes | Public Member Functions | List of all members
ndn::nfd::CsInfo Class Reference
Management

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 starts More...
 
uint64_t getNMisses () const
 get number of CS lookup misses since NFD starts More...
 
CsInfo & setCapacity (uint64_t capacity)
 
CsInfo & setEnableAdmit (bool enableAdmit)
 
CsInfo & setEnableServe (bool enableServe)
 
CsInfo & setNEntries (uint64_t nEntries)
 
CsInfo & setNHits (uint64_t nHits)
 
CsInfo & setNMisses (uint64_t nMisses)
 
void wireDecode (const Block &wire)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 
const Block & wireEncode () 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 37 of file cs-info.hpp.

Constructor & Destructor Documentation

◆ CsInfo() [1/2]

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

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

◆ CsInfo() [2/2]

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

Definition at line 41 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 64 of file cs-info.hpp.

◆ getEnableAdmit()

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

get CS_ENABLE_ADMIT flag

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

◆ getEnableServe()

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

get CS_ENABLE_SERVE flag

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

◆ getNEntries()

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

get number of stored CS entries

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

◆ getNHits()

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

get number of CS lookup hits since NFD starts

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

◆ getNMisses()

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

get number of CS lookup misses since NFD starts

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

◆ setCapacity()

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

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

◆ setEnableAdmit()

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

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

◆ setEnableServe()

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

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

◆ setNEntries()

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

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

◆ setNHits()

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

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

◆ setNMisses()

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

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

◆ wireDecode()

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

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

◆ wireEncode() [1/2]

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

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

◆ wireEncode() [2/2]

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

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