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

represents Face status 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
 
const time::milliseconds & getExpirationPeriod () const
 
FaceStatus & setExpirationPeriod (const time::milliseconds &expirationPeriod)
 
uint64_t getNInInterests () const
 
FaceStatus & setNInInterests (uint64_t nInInterests)
 
uint64_t getNInDatas () const
 
FaceStatus & setNInDatas (uint64_t nInDatas)
 
uint64_t getNInNacks () const
 
FaceStatus & setNInNacks (uint64_t nInNacks)
 
uint64_t getNOutInterests () const
 
FaceStatus & setNOutInterests (uint64_t nOutInterests)
 
uint64_t getNOutDatas () const
 
FaceStatus & setNOutDatas (uint64_t nOutDatas)
 
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 >
 FaceTraits ()
 
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)
 

Protected Member Functions

void wireReset () const
 

Additional Inherited Members

- 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
 

Detailed Description

represents Face status

See also
http://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 36 of file face-status.cpp.

◆ FaceStatus() [2/2]

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

Definition at line 49 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 56 of file face-status.cpp.

References 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::NInBytes, ndn::tlv::nfd::NInDatas, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NOutBytes, ndn::tlv::nfd::NOutDatas, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, ndn::encoding::prependNonNegativeIntegerBlock(), and ndn::tlv::nfd::Uri.

Referenced by nfd::FaceManager::setConfigFile().

◆ wireEncode() [2/2]

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

encode FaceStatus

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

References ndn::Block::hasWire().

◆ wireDecode()

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

decode FaceStatus

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

References 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::tlv::nfd::NInBytes, ndn::tlv::nfd::NInDatas, ndn::tlv::nfd::NInInterests, ndn::tlv::nfd::NInNacks, ndn::tlv::nfd::NOutBytes, ndn::tlv::nfd::NOutDatas, ndn::tlv::nfd::NOutInterests, ndn::tlv::nfd::NOutNacks, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), 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 ndn::nfd::operator<<().

◆ getExpirationPeriod()

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

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

References setExpirationPeriod().

Referenced by ndn::nfd::operator<<().

◆ setExpirationPeriod()

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

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

References ndn::Block::reset().

Referenced by getExpirationPeriod(), and nfd::FaceManager::setConfigFile().

◆ getNInInterests()

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

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

References setNInInterests().

Referenced by ndn::nfd::operator<<().

◆ setNInInterests()

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

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

References ndn::Block::reset().

Referenced by getNInInterests(), and nfd::FaceManager::setConfigFile().

◆ getNInDatas()

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

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

References setNInDatas().

Referenced by ndn::nfd::operator<<().

◆ setNInDatas()

FaceStatus & ndn::nfd::FaceStatus::setNInDatas ( uint64_t  nInDatas)

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

References ndn::Block::reset().

Referenced by getNInDatas(), and nfd::FaceManager::setConfigFile().

◆ getNInNacks()

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

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

References setNInNacks().

Referenced by ndn::nfd::operator<<().

◆ setNInNacks()

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

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

References ndn::Block::reset().

Referenced by getNInNacks(), and nfd::FaceManager::setConfigFile().

◆ getNOutInterests()

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

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

References setNOutInterests().

Referenced by ndn::nfd::operator<<().

◆ setNOutInterests()

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

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

References ndn::Block::reset().

Referenced by getNOutInterests(), and nfd::FaceManager::setConfigFile().

◆ getNOutDatas()

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

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

References setNOutDatas().

Referenced by ndn::nfd::operator<<().

◆ setNOutDatas()

FaceStatus & ndn::nfd::FaceStatus::setNOutDatas ( uint64_t  nOutDatas)

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

References ndn::Block::reset().

Referenced by getNOutDatas(), and nfd::FaceManager::setConfigFile().

◆ getNOutNacks()

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

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

References setNOutNacks().

Referenced by ndn::nfd::operator<<().

◆ setNOutNacks()

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

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

References ndn::Block::reset().

Referenced by getNOutNacks(), and nfd::FaceManager::setConfigFile().

◆ getNInBytes()

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

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

References setNInBytes().

Referenced by ndn::nfd::operator<<().

◆ setNInBytes()

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

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

References ndn::Block::reset().

Referenced by getNInBytes(), and nfd::FaceManager::setConfigFile().

◆ getNOutBytes()

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

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

References ndn::nfd::operator<<(), setNOutBytes(), and wireReset().

Referenced by ndn::nfd::operator<<().

◆ setNOutBytes()

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

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

References ndn::Block::reset().

Referenced by getNOutBytes(), and nfd::FaceManager::setConfigFile().

◆ wireReset()

void ndn::nfd::FaceStatus::wireReset ( ) const
protectedvirtual

Implements ndn::nfd::FaceTraits< FaceStatus >.

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

References ndn::Block::reset().

Referenced by getNOutBytes().

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