ndn::nfd::FaceStatus Class Reference

represents an item in NFD Face dataset More...

#include <ndn-cxx/mgmt/nfd/face-status.hpp>

Inheritance diagram for ndn::nfd::FaceStatus:

Collaboration diagram for ndn::nfd::FaceStatus:

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

Protected Attributes
uint64_t	m_faceId
FacePersistency	m_facePersistency
FaceScope	m_faceScope
uint64_t	m_flags
LinkType	m_linkType
std::string	m_localUri
std::string	m_remoteUri
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

ndn::nfd::FaceStatus::FaceStatus

(

)

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

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

explicit

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

Member Function Documentation

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

inline

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

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

inline

get default congestion threshold (measured in bytes)

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

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

inline

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

uint64_t ndn::nfd::FaceTraits< FaceStatus >::getFaceId ( ) const

inlineinherited

Definition at line 47 of file face-traits.hpp.

FacePersistency ndn::nfd::FaceTraits< FaceStatus >::getFacePersistency ( ) const

inlineinherited

Definition at line 103 of file face-traits.hpp.

FaceScope ndn::nfd::FaceTraits< FaceStatus >::getFaceScope ( ) const

inlineinherited

Definition at line 89 of file face-traits.hpp.

bool ndn::nfd::FaceTraits< FaceStatus >::getFlagBit ( size_t  bit ) const

inlineinherited

Definition at line 145 of file face-traits.hpp.

uint64_t ndn::nfd::FaceTraits< FaceStatus >::getFlags ( ) const

inlineinherited

Definition at line 131 of file face-traits.hpp.

LinkType ndn::nfd::FaceTraits< FaceStatus >::getLinkType ( ) const

inlineinherited

Definition at line 117 of file face-traits.hpp.

const std::string& ndn::nfd::FaceTraits< FaceStatus >::getLocalUri ( ) const

inlineinherited

Definition at line 75 of file face-traits.hpp.

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.

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

const std::string& ndn::nfd::FaceTraits< FaceStatus >::getRemoteUri ( ) const

inlineinherited

Definition at line 61 of file face-traits.hpp.

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

inline

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

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

inline

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

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

inline

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

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

inline

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

FaceStatus & ndn::nfd::FaceStatus::setBaseCongestionMarkingInterval

(

time::nanoseconds

interval

)

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

FaceStatus & ndn::nfd::FaceStatus::setDefaultCongestionThreshold

(

uint64_t

threshold

)

set default congestion threshold (measured in bytes)

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

FaceStatus & ndn::nfd::FaceStatus::setExpirationPeriod

(

time::milliseconds

expirationPeriod

)

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

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setFaceId ( uint64_t  faceId )

inlineinherited

Definition at line 53 of file face-traits.hpp.

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setFacePersistency ( FacePersistency  facePersistency )

inlineinherited

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

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setFaceScope ( FaceScope  faceScope )

inlineinherited

Definition at line 95 of file face-traits.hpp.

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setFlagBit ( size_t  bit, bool  value  )

inlineinherited

Definition at line 154 of file face-traits.hpp.

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setFlags ( uint64_t  flags )

inlineinherited

Definition at line 137 of file face-traits.hpp.

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setLinkType ( LinkType  linkType )

inlineinherited

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

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setLocalUri ( const std::string &  localUri )

inlineinherited

Definition at line 81 of file face-traits.hpp.

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.

FaceStatus & ndn::nfd::FaceStatus::setNInBytes

(

uint64_t

nInBytes

)

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

FaceStatus & ndn::nfd::FaceStatus::setNInData

(

uint64_t

nInData

)

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

FaceStatus & ndn::nfd::FaceStatus::setNInInterests

(

uint64_t

nInInterests

)

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

FaceStatus & ndn::nfd::FaceStatus::setNInNacks

(

uint64_t

nInNacks

)

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

FaceStatus & ndn::nfd::FaceStatus::setNOutBytes

(

uint64_t

nOutBytes

)

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

FaceStatus & ndn::nfd::FaceStatus::setNOutData

(

uint64_t

nOutData

)

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

FaceStatus & ndn::nfd::FaceStatus::setNOutInterests

(

uint64_t

nOutInterests

)

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

FaceStatus & ndn::nfd::FaceStatus::setNOutNacks

(

uint64_t

nOutNacks

)

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

FaceStatus & ndn::nfd::FaceTraits< FaceStatus >::setRemoteUri ( const std::string &  remoteUri )

inlineinherited

Definition at line 67 of file face-traits.hpp.

FaceStatus & ndn::nfd::FaceStatus::unsetBaseCongestionMarkingInterval

(

)

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

FaceStatus & ndn::nfd::FaceStatus::unsetDefaultCongestionThreshold

(

)

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

FaceStatus & ndn::nfd::FaceStatus::unsetExpirationPeriod

(

)

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

FaceStatus & ndn::nfd::FaceStatus::unsetMtu

(

)

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

void ndn::nfd::FaceStatus::wireDecode

(

const Block &

wire

)

decode FaceStatus

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

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.

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

(

)

const

encode FaceStatus

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

Member Data Documentation

uint64_t ndn::nfd::FaceTraits< FaceStatus >::m_faceId

protectedinherited

Definition at line 183 of file face-traits.hpp.

FacePersistency ndn::nfd::FaceTraits< FaceStatus >::m_facePersistency

protectedinherited

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

FaceScope ndn::nfd::FaceTraits< FaceStatus >::m_faceScope

protectedinherited

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

uint64_t ndn::nfd::FaceTraits< FaceStatus >::m_flags

protectedinherited

Definition at line 189 of file face-traits.hpp.

LinkType ndn::nfd::FaceTraits< FaceStatus >::m_linkType

protectedinherited

Definition at line 188 of file face-traits.hpp.

std::string ndn::nfd::FaceTraits< FaceStatus >::m_localUri

protectedinherited

Definition at line 185 of file face-traits.hpp.

std::string ndn::nfd::FaceTraits< FaceStatus >::m_remoteUri

protectedinherited

Definition at line 184 of file face-traits.hpp.

Block ndn::nfd::FaceTraits< FaceStatus >::m_wire

mutableprotectedinherited

Definition at line 191 of file face-traits.hpp.