Public Member Functions | Protected Attributes | List of all members
ndn::nfd::FaceEventNotification Class Reference

Represents a Face status change notification. More...

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

+ Inheritance diagram for ndn::nfd::FaceEventNotification:
+ Collaboration diagram for ndn::nfd::FaceEventNotification:

Public Member Functions

 FaceEventNotification ()
 
 FaceEventNotification (const Block &block)
 
uint64_t getFaceId () const
 
FacePersistency getFacePersistency () const
 
FaceScope getFaceScope () const
 
bool getFlagBit (size_t bit) const
 
uint64_t getFlags () const
 
FaceEventKind getKind () const
 
LinkType getLinkType () const
 
const std::string & getLocalUri () const
 
const std::string & getRemoteUri () const
 
FaceEventNotification & setFaceId (uint64_t faceId)
 
FaceEventNotification & setFacePersistency (FacePersistency facePersistency)
 
FaceEventNotification & setFaceScope (FaceScope faceScope)
 
FaceEventNotification & setFlagBit (size_t bit, bool value)
 
FaceEventNotification & setFlags (uint64_t flags)
 
FaceEventNotification & setKind (FaceEventKind kind)
 
FaceEventNotification & setLinkType (LinkType linkType)
 
FaceEventNotification & setLocalUri (const std::string &localUri)
 
FaceEventNotification & setRemoteUri (const std::string &remoteUri)
 
void wireDecode (const Block &wire)
 Decode FaceEventNotification. More...
 
const Block & wireEncode () const
 Encode FaceEventNotification. More...
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 Prepend FaceEventNotification to the encoder. 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 a Face status change notification.

See also
https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Face-Status-Change-Notification

Definition at line 34 of file face-event-notification.hpp.

Constructor & Destructor Documentation

◆ FaceEventNotification() [1/2]

ndn::nfd::FaceEventNotification::FaceEventNotification ( )
default

◆ FaceEventNotification() [2/2]

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

Definition at line 32 of file face-event-notification.cpp.

Member Function Documentation

◆ getFaceId()

uint64_t ndn::nfd::FaceTraits< FaceEventNotification >::getFaceId ( ) const
inlineinherited

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

◆ getFacePersistency()

FacePersistency ndn::nfd::FaceTraits< FaceEventNotification >::getFacePersistency ( ) const
inlineinherited

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

◆ getFaceScope()

FaceScope ndn::nfd::FaceTraits< FaceEventNotification >::getFaceScope ( ) const
inlineinherited

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

◆ getFlagBit()

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

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

◆ getFlags()

uint64_t ndn::nfd::FaceTraits< FaceEventNotification >::getFlags ( ) const
inlineinherited

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

◆ getKind()

FaceEventKind ndn::nfd::FaceEventNotification::getKind ( ) const
inline

Definition at line 60 of file face-event-notification.hpp.

◆ getLinkType()

LinkType ndn::nfd::FaceTraits< FaceEventNotification >::getLinkType ( ) const
inlineinherited

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

◆ getLocalUri()

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

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

◆ getRemoteUri()

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

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

◆ setFaceId()

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

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

◆ setFacePersistency()

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

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

◆ setFaceScope()

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

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

◆ setFlagBit()

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

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

◆ setFlags()

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

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

◆ setKind()

FaceEventNotification & ndn::nfd::FaceEventNotification::setKind ( FaceEventKind  kind)

Definition at line 152 of file face-event-notification.cpp.

◆ setLinkType()

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

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

◆ setLocalUri()

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

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

◆ setRemoteUri()

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

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

◆ wireDecode()

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

Decode FaceEventNotification.

Definition at line 76 of file face-event-notification.cpp.

◆ wireEncode() [1/2]

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

Encode FaceEventNotification.

Definition at line 60 of file face-event-notification.cpp.

◆ wireEncode() [2/2]

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

Prepend FaceEventNotification to the encoder.

Definition at line 39 of file face-event-notification.cpp.

Member Data Documentation

◆ m_faceId

uint64_t ndn::nfd::FaceTraits< FaceEventNotification >::m_faceId
protectedinherited

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

◆ m_facePersistency

FacePersistency ndn::nfd::FaceTraits< FaceEventNotification >::m_facePersistency
protectedinherited

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

◆ m_faceScope

FaceScope ndn::nfd::FaceTraits< FaceEventNotification >::m_faceScope
protectedinherited

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

◆ m_flags

uint64_t ndn::nfd::FaceTraits< FaceEventNotification >::m_flags
protectedinherited

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

◆ m_linkType

LinkType ndn::nfd::FaceTraits< FaceEventNotification >::m_linkType
protectedinherited

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

◆ m_localUri

std::string ndn::nfd::FaceTraits< FaceEventNotification >::m_localUri
protectedinherited

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

◆ m_remoteUri

std::string ndn::nfd::FaceTraits< FaceEventNotification >::m_remoteUri
protectedinherited

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

◆ m_wire

Block ndn::nfd::FaceTraits< FaceEventNotification >::m_wire
mutableprotectedinherited

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