NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ndn::nfd::FaceTraits< C > Class Template Referenceabstract
Management

providers getters and setters of face information fields More...

#include <face-traits.hpp>

Inheritance diagram for ndn::nfd::FaceTraits< C >:
Inheritance graph
[legend]
Collaboration diagram for ndn::nfd::FaceTraits< C >:
Collaboration graph
[legend]

Classes

class  Error
 

Public Member Functions

 FaceTraits ()
 
uint64_t getFaceId () const
 
C & setFaceId (uint64_t faceId)
 
const std::string & getRemoteUri () const
 
C & setRemoteUri (const std::string &remoteUri)
 
const std::string & getLocalUri () const
 
C & setLocalUri (const std::string &localUri)
 
FaceScope getFaceScope () const
 
C & setFaceScope (FaceScope faceScope)
 
FacePersistency getFacePersistency () const
 
C & setFacePersistency (FacePersistency facePersistency)
 
LinkType getLinkType () const
 
C & setLinkType (LinkType linkType)
 
uint64_t getFlags () const
 
C & setFlags (uint64_t flags)
 
bool getFlagBit (size_t bit) const
 
C & setFlagBit (size_t bit, bool value)
 

Protected Member Functions

virtual void wireReset () const =0
 

Protected Attributes

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

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

providers getters and setters of face information fields

Template Parameters
Cthe concrete class; it must provide .wireReset() method to clear wire encoding when a field changes

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

Constructor & Destructor Documentation

◆ FaceTraits()

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

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

Member Function Documentation

◆ getFaceId()

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

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

Referenced by nfd::rib::RibManager::onRibUpdateFailure(), and ndn::nfd::operator<<().

◆ setFaceId()

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

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

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

◆ getRemoteUri()

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

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

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

◆ setRemoteUri()

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

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

◆ getLocalUri()

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

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

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

◆ setLocalUri()

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

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

◆ getFaceScope()

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

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

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

◆ setFaceScope()

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

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

◆ getFacePersistency()

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

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

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

◆ setFacePersistency()

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

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

◆ getLinkType()

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

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

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

◆ setLinkType()

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

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

◆ getFlags()

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

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

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

◆ setFlags()

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

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

◆ getFlagBit()

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

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

◆ setFlagBit()

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

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

◆ wireReset()

template<class C>
virtual void ndn::nfd::FaceTraits< C >::wireReset ( ) const
protectedpure virtual

Implemented in ndn::nfd::FaceStatus, and ndn::nfd::FaceEventNotification.

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::setFaceId(), ndn::nfd::FaceTraits< FaceEventNotification >::setFacePersistency(), ndn::nfd::FaceTraits< FaceEventNotification >::setFaceScope(), ndn::nfd::FaceTraits< FaceEventNotification >::setFlagBit(), ndn::nfd::FaceTraits< FaceEventNotification >::setFlags(), ndn::nfd::FaceTraits< FaceEventNotification >::setLinkType(), ndn::nfd::FaceTraits< FaceEventNotification >::setLocalUri(), and ndn::nfd::FaceTraits< FaceEventNotification >::setRemoteUri().

Member Data Documentation

◆ m_faceId

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getFaceId(), and ndn::nfd::FaceTraits< FaceEventNotification >::setFaceId().

◆ m_remoteUri

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getRemoteUri(), and ndn::nfd::FaceTraits< FaceEventNotification >::setRemoteUri().

◆ m_localUri

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getLocalUri(), and ndn::nfd::FaceTraits< FaceEventNotification >::setLocalUri().

◆ m_faceScope

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getFaceScope(), and ndn::nfd::FaceTraits< FaceEventNotification >::setFaceScope().

◆ m_facePersistency

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getFacePersistency(), and ndn::nfd::FaceTraits< FaceEventNotification >::setFacePersistency().

◆ m_linkType

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getLinkType(), and ndn::nfd::FaceTraits< FaceEventNotification >::setLinkType().

◆ m_flags

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

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

Referenced by ndn::nfd::FaceTraits< FaceEventNotification >::getFlagBit(), ndn::nfd::FaceTraits< FaceEventNotification >::getFlags(), ndn::nfd::FaceTraits< FaceEventNotification >::setFlagBit(), and ndn::nfd::FaceTraits< FaceEventNotification >::setFlags().

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