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

represents a Face status change notification More...

#include <face-event-notification.hpp>

Inheritance diagram for ndn::nfd::FaceEventNotification:
Inheritance graph
[legend]
Collaboration diagram for ndn::nfd::FaceEventNotification:
Collaboration graph
[legend]

Public Member Functions

 FaceEventNotification ()
 
 FaceEventNotification (const Block &block)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 prepend FaceEventNotification to the encoder More...
 
const Block & wireEncode () const
 encode FaceEventNotification More...
 
void wireDecode (const Block &wire)
 decode FaceEventNotification More...
 
FaceEventKind getKind () const
 
FaceEventNotification & setKind (FaceEventKind kind)
 
- Public Member Functions inherited from ndn::nfd::FaceTraits< FaceEventNotification >
uint64_t getFaceId () const
 
FaceEventNotification & setFaceId (uint64_t faceId)
 
const std::string & getRemoteUri () const
 
FaceEventNotification & setRemoteUri (const std::string &remoteUri)
 
const std::string & getLocalUri () const
 
FaceEventNotification & setLocalUri (const std::string &localUri)
 
FaceScope getFaceScope () const
 
FaceEventNotification & setFaceScope (FaceScope faceScope)
 
FacePersistency getFacePersistency () const
 
FaceEventNotification & setFacePersistency (FacePersistency facePersistency)
 
LinkType getLinkType () const
 
FaceEventNotification & setLinkType (LinkType linkType)
 
uint64_t getFlags () const
 
FaceEventNotification & setFlags (uint64_t flags)
 
bool getFlagBit (size_t bit) const
 
FaceEventNotification & setFlagBit (size_t bit, bool value)
 

Additional Inherited Members

- Protected Member Functions inherited from ndn::nfd::FaceTraits< FaceEventNotification >
 FaceTraits ()
 
- Protected Attributes inherited from ndn::nfd::FaceTraits< FaceEventNotification >
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
 
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 35 of file face-event-notification.hpp.

Constructor & Destructor Documentation

◆ FaceEventNotification() [1/2]

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

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

◆ FaceEventNotification() [2/2]

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

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

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

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

prepend FaceEventNotification to the encoder

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

References ndn::tlv::nfd::FaceEventKind, ndn::tlv::nfd::FaceEventNotification, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceScope, ndn::tlv::nfd::Flags, ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, ndn::nfd::FaceTraits< FaceEventNotification >::m_faceId, ndn::nfd::FaceTraits< FaceEventNotification >::m_facePersistency, ndn::nfd::FaceTraits< FaceEventNotification >::m_faceScope, ndn::nfd::FaceTraits< FaceEventNotification >::m_flags, ndn::nfd::FaceTraits< FaceEventNotification >::m_linkType, ndn::nfd::FaceTraits< FaceEventNotification >::m_localUri, ndn::nfd::FaceTraits< FaceEventNotification >::m_remoteUri, ndn::encoding::prependNonNegativeIntegerBlock(), ndn::encoding::prependStringBlock(), and ndn::tlv::nfd::Uri.

◆ wireEncode() [2/2]

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

encode FaceEventNotification

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

References ndn::Block::hasWire(), and ndn::nfd::FaceTraits< FaceEventNotification >::m_wire.

◆ wireDecode()

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

decode FaceEventNotification

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

References ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::nfd::FaceEventKind, ndn::tlv::nfd::FaceEventNotification, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceScope, ndn::tlv::nfd::Flags, ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, ndn::nfd::FaceTraits< FaceEventNotification >::m_faceId, ndn::nfd::FaceTraits< FaceEventNotification >::m_facePersistency, ndn::nfd::FaceTraits< FaceEventNotification >::m_faceScope, ndn::nfd::FaceTraits< FaceEventNotification >::m_flags, ndn::nfd::FaceTraits< FaceEventNotification >::m_linkType, ndn::nfd::FaceTraits< FaceEventNotification >::m_localUri, ndn::nfd::FaceTraits< FaceEventNotification >::m_remoteUri, ndn::nfd::FaceTraits< FaceEventNotification >::m_wire, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::Block::type(), and ndn::tlv::nfd::Uri.

Referenced by FaceEventNotification().

◆ getKind()

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

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

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

◆ setKind()

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

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

References ndn::nfd::FaceTraits< FaceEventNotification >::m_wire, and ndn::Block::reset().

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