NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::nfd::FaceStatus Class Reference

represents an item in NFD Face dataset More...

#include <face-status.hpp>

Inheritance diagram for ndn::nfd::FaceStatus:
Collaboration diagram for ndn::nfd::FaceStatus:

Public Member Functions

 FaceStatus ()
 
 FaceStatus (const Block &block)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 prepend FaceStatus to the encoder More...
 
const BlockwireEncode () const
 encode FaceStatus More...
 
void wireDecode (const Block &wire)
 decode FaceStatus More...
 
bool hasExpirationPeriod () const
 
time::milliseconds getExpirationPeriod () const
 
FaceStatussetExpirationPeriod (time::milliseconds expirationPeriod)
 
FaceStatusunsetExpirationPeriod ()
 
bool hasBaseCongestionMarkingInterval () const
 
time::nanoseconds getBaseCongestionMarkingInterval () const
 
FaceStatussetBaseCongestionMarkingInterval (time::nanoseconds interval)
 
FaceStatusunsetBaseCongestionMarkingInterval ()
 
bool hasDefaultCongestionThreshold () const
 
uint64_t getDefaultCongestionThreshold () const
 get default congestion threshold (measured in bytes) More...
 
FaceStatussetDefaultCongestionThreshold (uint64_t threshold)
 set default congestion threshold (measured in bytes) More...
 
FaceStatusunsetDefaultCongestionThreshold ()
 
bool hasMtu () const
 
uint64_t getMtu () const
 get MTU (measured in bytes) More...
 
FaceStatussetMtu (uint64_t mtu)
 set MTU (measured in bytes) More...
 
FaceStatusunsetMtu ()
 
uint64_t getNInInterests () const
 
FaceStatussetNInInterests (uint64_t nInInterests)
 
uint64_t getNInData () const
 
FaceStatussetNInData (uint64_t nInData)
 
uint64_t getNInNacks () const
 
FaceStatussetNInNacks (uint64_t nInNacks)
 
uint64_t getNOutInterests () const
 
FaceStatussetNOutInterests (uint64_t nOutInterests)
 
uint64_t getNOutData () const
 
FaceStatussetNOutData (uint64_t nOutData)
 
uint64_t getNOutNacks () const
 
FaceStatussetNOutNacks (uint64_t nOutNacks)
 
uint64_t getNInBytes () const
 
FaceStatussetNInBytes (uint64_t nInBytes)
 
uint64_t getNOutBytes () const
 
FaceStatussetNOutBytes (uint64_t nOutBytes)
 
- Public Member Functions inherited from ndn::nfd::FaceTraits< FaceStatus >
uint64_t getFaceId () const
 
FaceStatussetFaceId (uint64_t faceId)
 
const std::string & getRemoteUri () const
 
FaceStatussetRemoteUri (const std::string &remoteUri)
 
const std::string & getLocalUri () const
 
FaceStatussetLocalUri (const std::string &localUri)
 
FaceScope getFaceScope () const
 
FaceStatussetFaceScope (FaceScope faceScope)
 
FacePersistency getFacePersistency () const
 
FaceStatussetFacePersistency (FacePersistency facePersistency)
 
LinkType getLinkType () const
 
FaceStatussetLinkType (LinkType linkType)
 
uint64_t getFlags () const
 
FaceStatussetFlags (uint64_t flags)
 
bool getFlagBit (size_t bit) const
 
FaceStatussetFlagBit (size_t bit, bool value)
 

Additional Inherited Members

- Protected Member Functions inherited from ndn::nfd::FaceTraits< FaceStatus >
 FaceTraits ()
 
- Protected Attributes inherited from ndn::nfd::FaceTraits< FaceStatus >
uint64_t m_faceId
 
std::string m_remoteUri
 
std::string m_localUri
 
FaceScope m_faceScope
 
FacePersistency m_facePersistency
 
LinkType m_linkType
 
uint64_t m_flags
 
Block m_wire
 

Detailed Description

represents an item in NFD Face dataset

See also
https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Face-Dataset

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

Constructor & Destructor Documentation

◆ FaceStatus() [1/2]

ndn::nfd::FaceStatus::FaceStatus ( )

Definition at line 34 of file face-status.cpp.

◆ FaceStatus() [2/2]

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

Definition at line 46 of file face-status.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

◆ wireEncode() [2/2]

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

◆ wireDecode()

◆ hasExpirationPeriod()

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

Definition at line 62 of file face-status.hpp.

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

◆ getExpirationPeriod()

time::milliseconds ndn::nfd::FaceStatus::getExpirationPeriod ( ) const
inline

Definition at line 68 of file face-status.hpp.

References hasExpirationPeriod().

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

◆ setExpirationPeriod()

FaceStatus & ndn::nfd::FaceStatus::setExpirationPeriod ( time::milliseconds  expirationPeriod)

◆ unsetExpirationPeriod()

FaceStatus & ndn::nfd::FaceStatus::unsetExpirationPeriod ( )

◆ hasBaseCongestionMarkingInterval()

bool ndn::nfd::FaceStatus::hasBaseCongestionMarkingInterval ( ) const
inline

◆ getBaseCongestionMarkingInterval()

time::nanoseconds ndn::nfd::FaceStatus::getBaseCongestionMarkingInterval ( ) const
inline

Definition at line 87 of file face-status.hpp.

References hasBaseCongestionMarkingInterval().

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

◆ setBaseCongestionMarkingInterval()

FaceStatus & ndn::nfd::FaceStatus::setBaseCongestionMarkingInterval ( time::nanoseconds  interval)

◆ unsetBaseCongestionMarkingInterval()

FaceStatus & ndn::nfd::FaceStatus::unsetBaseCongestionMarkingInterval ( )

◆ hasDefaultCongestionThreshold()

bool ndn::nfd::FaceStatus::hasDefaultCongestionThreshold ( ) const
inline

◆ getDefaultCongestionThreshold()

uint64_t ndn::nfd::FaceStatus::getDefaultCongestionThreshold ( ) const
inline

get default congestion threshold (measured in bytes)

Definition at line 108 of file face-status.hpp.

References hasDefaultCongestionThreshold().

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

◆ setDefaultCongestionThreshold()

FaceStatus & ndn::nfd::FaceStatus::setDefaultCongestionThreshold ( uint64_t  threshold)

set default congestion threshold (measured in bytes)

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

References ndn::nfd::FaceTraits< FaceStatus >::m_wire, and ndn::Block::reset().

Referenced by nfd::makeFaceStatus().

◆ unsetDefaultCongestionThreshold()

FaceStatus & ndn::nfd::FaceStatus::unsetDefaultCongestionThreshold ( )

◆ hasMtu()

bool ndn::nfd::FaceStatus::hasMtu ( ) const
inline

Definition at line 123 of file face-status.hpp.

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

◆ getMtu()

uint64_t ndn::nfd::FaceStatus::getMtu ( ) const
inline

get MTU (measured in bytes)

This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.

Definition at line 133 of file face-status.hpp.

References hasMtu().

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

◆ setMtu()

FaceStatus & ndn::nfd::FaceStatus::setMtu ( uint64_t  mtu)

set MTU (measured in bytes)

This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.

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

References ndn::nfd::FaceTraits< FaceStatus >::m_wire, and ndn::Block::reset().

◆ unsetMtu()

FaceStatus & ndn::nfd::FaceStatus::unsetMtu ( )

◆ getNInInterests()

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

Definition at line 150 of file face-status.hpp.

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

◆ setNInInterests()

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

◆ getNInData()

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

Definition at line 159 of file face-status.hpp.

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

◆ setNInData()

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

◆ getNInNacks()

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

Definition at line 168 of file face-status.hpp.

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

◆ setNInNacks()

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

◆ getNOutInterests()

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

Definition at line 177 of file face-status.hpp.

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

◆ setNOutInterests()

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

◆ getNOutData()

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

Definition at line 186 of file face-status.hpp.

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

◆ setNOutData()

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

◆ getNOutNacks()

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

Definition at line 195 of file face-status.hpp.

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

◆ setNOutNacks()

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

◆ getNInBytes()

uint64_t ndn::nfd::FaceStatus::getNInBytes ( ) const
inline

Definition at line 204 of file face-status.hpp.

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

◆ setNInBytes()

FaceStatus & ndn::nfd::FaceStatus::setNInBytes ( uint64_t  nInBytes)

◆ getNOutBytes()

uint64_t ndn::nfd::FaceStatus::getNOutBytes ( ) const
inline

Definition at line 213 of file face-status.hpp.

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

◆ setNOutBytes()

FaceStatus & ndn::nfd::FaceStatus::setNOutBytes ( uint64_t  nOutBytes)

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