ndn::nfd::FaceTraits< C > Class Template Reference

Provides getters and setters for face information fields. More...

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

+ Inheritance diagram for ndn::nfd::FaceTraits< C >:
+ Collaboration diagram for ndn::nfd::FaceTraits< C >:

Classes

class  Error
 

Public Member Functions

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
 
const std::string & getRemoteUri () const
 
C & setFaceId (uint64_t faceId)
 
C & setFacePersistency (FacePersistency facePersistency)
 
C & setFaceScope (FaceScope faceScope)
 
C & setFlagBit (size_t bit, bool value)
 
C & setFlags (uint64_t flags)
 
C & setLinkType (LinkType linkType)
 
C & setLocalUri (const std::string &localUri)
 
C & setRemoteUri (const std::string &remoteUri)
 

Protected Member Functions

 FaceTraits ()=default
 

Protected Attributes

uint64_t m_faceId = INVALID_FACE_ID
 
FacePersistency m_facePersistency = FACE_PERSISTENCY_PERSISTENT
 
FaceScope m_faceScope = FACE_SCOPE_NON_LOCAL
 
uint64_t m_flags = 0
 
LinkType m_linkType = LINK_TYPE_POINT_TO_POINT
 
std::string m_localUri
 
std::string m_remoteUri
 
Block m_wire
 

Detailed Description

template<class C>
class ndn::nfd::FaceTraits< C >

Provides getters and setters for face information fields.

Template Parameters
CThe concrete subclass

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

Constructor & Destructor Documentation

◆ FaceTraits()

template<class C >
ndn::nfd::FaceTraits< C >::FaceTraits ( )
protecteddefault

Member Function Documentation

◆ getFaceId()

template<class C >
uint64_t ndn::nfd::FaceTraits< C >::getFaceId ( ) const
inline

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

◆ getFacePersistency()

template<class C >
FacePersistency ndn::nfd::FaceTraits< C >::getFacePersistency ( ) const
inline

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

◆ getFaceScope()

template<class C >
FaceScope ndn::nfd::FaceTraits< C >::getFaceScope ( ) const
inline

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

◆ getFlagBit()

template<class C >
bool ndn::nfd::FaceTraits< C >::getFlagBit ( size_t  bit) const
inline

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

◆ getFlags()

template<class C >
uint64_t ndn::nfd::FaceTraits< C >::getFlags ( ) const
inline

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

◆ getLinkType()

template<class C >
LinkType ndn::nfd::FaceTraits< C >::getLinkType ( ) const
inline

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

◆ getLocalUri()

template<class C >
const std::string& ndn::nfd::FaceTraits< C >::getLocalUri ( ) const
inline

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

◆ getRemoteUri()

template<class C >
const std::string& ndn::nfd::FaceTraits< C >::getRemoteUri ( ) const
inline

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

◆ setFaceId()

template<class C >
C& ndn::nfd::FaceTraits< C >::setFaceId ( uint64_t  faceId)
inline

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

◆ setFacePersistency()

template<class C >
C& ndn::nfd::FaceTraits< C >::setFacePersistency ( FacePersistency  facePersistency)
inline

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

◆ setFaceScope()

template<class C >
C& ndn::nfd::FaceTraits< C >::setFaceScope ( FaceScope  faceScope)
inline

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

◆ setFlagBit()

template<class C >
C& ndn::nfd::FaceTraits< C >::setFlagBit ( size_t  bit,
bool  value 
)
inline

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

◆ setFlags()

template<class C >
C& ndn::nfd::FaceTraits< C >::setFlags ( uint64_t  flags)
inline

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

◆ setLinkType()

template<class C >
C& ndn::nfd::FaceTraits< C >::setLinkType ( LinkType  linkType)
inline

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

◆ setLocalUri()

template<class C >
C& ndn::nfd::FaceTraits< C >::setLocalUri ( const std::string &  localUri)
inline

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

◆ setRemoteUri()

template<class C >
C& ndn::nfd::FaceTraits< C >::setRemoteUri ( const std::string &  remoteUri)
inline

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

Member Data Documentation

◆ m_faceId

template<class C >
uint64_t ndn::nfd::FaceTraits< C >::m_faceId = INVALID_FACE_ID
protected

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

◆ m_facePersistency

template<class C >
FacePersistency ndn::nfd::FaceTraits< C >::m_facePersistency = FACE_PERSISTENCY_PERSISTENT
protected

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

◆ m_faceScope

template<class C >
FaceScope ndn::nfd::FaceTraits< C >::m_faceScope = FACE_SCOPE_NON_LOCAL
protected

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

◆ m_flags

template<class C >
uint64_t ndn::nfd::FaceTraits< C >::m_flags = 0
protected

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

◆ m_linkType

template<class C >
LinkType ndn::nfd::FaceTraits< C >::m_linkType = LINK_TYPE_POINT_TO_POINT
protected

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

◆ m_localUri

template<class C >
std::string ndn::nfd::FaceTraits< C >::m_localUri
protected

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

◆ m_remoteUri

template<class C >
std::string ndn::nfd::FaceTraits< C >::m_remoteUri
protected

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

◆ m_wire

template<class C >
Block ndn::nfd::FaceTraits< C >::m_wire
mutableprotected

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