NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Member Functions | List of all members
ndn::nfd::FaceStatus Class Reference
Management

represents an item in NFD Face dataset More...

#include <face-status.hpp>

Inheritance diagram for ndn::nfd::FaceStatus:
Inheritance graph
[legend]
Collaboration diagram for ndn::nfd::FaceStatus:
Collaboration graph
[legend]

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 Block & wireEncode () const
 encode FaceStatus More...
 
void wireDecode (const Block &wire)
 decode FaceStatus More...
 
bool hasExpirationPeriod () const
 
time::milliseconds getExpirationPeriod () const
 
FaceStatus & setExpirationPeriod (time::milliseconds expirationPeriod)
 
FaceStatus & unsetExpirationPeriod ()
 
bool hasBaseCongestionMarkingInterval () const
 
time::nanoseconds getBaseCongestionMarkingInterval () const
 
FaceStatus & setBaseCongestionMarkingInterval (time::nanoseconds interval)
 
FaceStatus & unsetBaseCongestionMarkingInterval ()
 
bool hasDefaultCongestionThreshold () const
 
uint64_t getDefaultCongestionThreshold () const
 get default congestion threshold (measured in bytes) More...
 
FaceStatus & setDefaultCongestionThreshold (uint64_t threshold)
 set default congestion threshold (measured in bytes) More...
 
FaceStatus & unsetDefaultCongestionThreshold ()
 
bool hasMtu () const
 
uint64_t getMtu () const
 get MTU (measured in bytes) More...
 
FaceStatus & setMtu (uint64_t mtu)
 set MTU (measured in bytes) More...
 
FaceStatus & unsetMtu ()
 
uint64_t getNInInterests () const
 
FaceStatus & setNInInterests (uint64_t nInInterests)
 
uint64_t getNInData () const
 
FaceStatus & setNInData (uint64_t nInData)
 
uint64_t getNInNacks () const
 
FaceStatus & setNInNacks (uint64_t nInNacks)
 
uint64_t getNOutInterests () const
 
FaceStatus & setNOutInterests (uint64_t nOutInterests)
 
uint64_t getNOutData () const
 
FaceStatus & setNOutData (uint64_t nOutData)
 
uint64_t getNOutNacks () const
 
FaceStatus & setNOutNacks (uint64_t nOutNacks)
 
uint64_t getNInBytes () const
 
FaceStatus & setNInBytes (uint64_t nInBytes)
 
uint64_t getNOutBytes () const
 
FaceStatus & setNOutBytes (uint64_t nOutBytes)
 
- Public Member Functions inherited from ndn::nfd::FaceTraits< FaceStatus >
uint64_t getFaceId () const
 
FaceStatus & setFaceId (uint64_t faceId)
 
const std::string & getRemoteUri () const
 
FaceStatus & setRemoteUri (const std::string &remoteUri)
 
const std::string & getLocalUri () const
 
FaceStatus & setLocalUri (const std::string &localUri)
 
FaceScope getFaceScope () const
 
FaceStatus & setFaceScope (FaceScope faceScope)
 
FacePersistency getFacePersistency () const
 
FaceStatus & setFacePersistency (FacePersistency facePersistency)
 
LinkType getLinkType () const
 
FaceStatus & setLinkType (LinkType linkType)
 
uint64_t getFlags () const
 
FaceStatus & setFlags (uint64_t flags)
 
bool getFlagBit (size_t bit) const
 
FaceStatus & setFlagBit (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 37 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]

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

prepend FaceStatus to the encoder

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

References ndn::tlv::nfd::BaseCongestionMarkingInterval, ndn::tlv::nfd::DefaultCongestionThreshold, ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceScope, ndn::tlv::nfd::FaceStatus, ndn::tlv::nfd::Flags, ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, ndn::nfd::FaceTraits< FaceStatus >::m_faceId, ndn::nfd::FaceTraits< FaceStatus >::m_facePersistency, ndn::nfd::FaceTraits< FaceStatus >::m_faceScope, ndn::nfd::FaceTraits< FaceStatus >::m_flags, ndn::nfd::FaceTraits< FaceStatus >::m_linkType, ndn::nfd::FaceTraits< FaceStatus >::m_localUri, ndn::nfd::FaceTraits< FaceStatus >::m_remoteUri, ndn::tlv::nfd::Mtu, ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::tlv::nfd::NInBytes, ndn::tlv::nfd::NInData, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NOutBytes, ndn::tlv::nfd::NOutData, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, ndn::encoding::prependNonNegativeIntegerBlock(), ndn::encoding::prependStringBlock(), and ndn::tlv::nfd::Uri.

Referenced by nfd::makeFaceStatus(), and nfd::matchFilter().

◆ wireEncode() [2/2]

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

encode FaceStatus

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

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

◆ wireDecode()

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

decode FaceStatus

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

References ndn::tlv::nfd::BaseCongestionMarkingInterval, ndn::tlv::nfd::DefaultCongestionThreshold, ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceScope, ndn::tlv::nfd::FaceStatus, ndn::tlv::nfd::Flags, ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, ndn::nfd::FaceTraits< FaceStatus >::m_faceId, ndn::nfd::FaceTraits< FaceStatus >::m_facePersistency, ndn::nfd::FaceTraits< FaceStatus >::m_faceScope, ndn::nfd::FaceTraits< FaceStatus >::m_flags, ndn::nfd::FaceTraits< FaceStatus >::m_linkType, ndn::nfd::FaceTraits< FaceStatus >::m_localUri, ndn::nfd::FaceTraits< FaceStatus >::m_remoteUri, ndn::nfd::FaceTraits< FaceStatus >::m_wire, ndn::tlv::nfd::Mtu, NDN_THROW, ndn::tlv::nfd::NInBytes, ndn::tlv::nfd::NInData, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NOutBytes, ndn::tlv::nfd::NOutData, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, nonstd::optional_lite::nullopt, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::Block::type(), and ndn::tlv::nfd::Uri.

Referenced by FaceStatus().

◆ hasExpirationPeriod()

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

Definition at line 63 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 69 of file face-status.hpp.

References hasExpirationPeriod(), setExpirationPeriod(), and unsetExpirationPeriod().

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

◆ setExpirationPeriod()

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

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

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

Referenced by getExpirationPeriod(), and nfd::makeFaceStatus().

◆ unsetExpirationPeriod()

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

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

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

Referenced by getExpirationPeriod().

◆ hasBaseCongestionMarkingInterval()

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

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

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

◆ getBaseCongestionMarkingInterval()

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

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

References hasBaseCongestionMarkingInterval(), setBaseCongestionMarkingInterval(), and unsetBaseCongestionMarkingInterval().

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

◆ setBaseCongestionMarkingInterval()

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

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

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

Referenced by getBaseCongestionMarkingInterval(), and nfd::makeFaceStatus().

◆ unsetBaseCongestionMarkingInterval()

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

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

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

Referenced by getBaseCongestionMarkingInterval().

◆ hasDefaultCongestionThreshold()

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

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

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

◆ getDefaultCongestionThreshold()

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

get default congestion threshold (measured in bytes)

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

References hasDefaultCongestionThreshold(), setDefaultCongestionThreshold(), and unsetDefaultCongestionThreshold().

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 getDefaultCongestionThreshold(), and nfd::makeFaceStatus().

◆ unsetDefaultCongestionThreshold()

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

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

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

Referenced by getDefaultCongestionThreshold().

◆ hasMtu()

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

Definition at line 124 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 134 of file face-status.hpp.

References hasMtu(), setMtu(), and unsetMtu().

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().

Referenced by getMtu().

◆ unsetMtu()

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

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

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

Referenced by getMtu().

◆ getNInInterests()

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

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

References setNInInterests().

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

◆ setNInInterests()

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

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

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

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

◆ getNInData()

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

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

References setNInData().

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

◆ setNInData()

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

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

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

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

◆ getNInNacks()

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

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

References setNInNacks().

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

◆ setNInNacks()

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

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

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

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

◆ getNOutInterests()

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

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

References setNOutInterests().

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

◆ setNOutInterests()

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

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

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

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

◆ getNOutData()

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

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

References setNOutData().

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

◆ setNOutData()

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

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

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

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

◆ getNOutNacks()

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

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

References setNOutNacks().

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

◆ setNOutNacks()

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

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

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

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

◆ getNInBytes()

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

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

References setNInBytes().

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

◆ setNInBytes()

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

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

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

Referenced by getNInBytes(), and nfd::makeFaceStatus().

◆ getNOutBytes()

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

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

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

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

◆ setNOutBytes()

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

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

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

Referenced by getNOutBytes(), and nfd::makeFaceStatus().

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