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

represents Face Query Filter More...

#include <face-query-filter.hpp>

Classes

class  Error
 

Public Member Functions

 FaceQueryFilter ()
 
 FaceQueryFilter (const Block &block)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 prepend FaceQueryFilter to the encoder More...
 
const Block & wireEncode () const
 encode FaceQueryFilter More...
 
void wireDecode (const Block &wire)
 decode FaceQueryFilter More...
 
bool empty () const
 
bool hasFaceId () const
 
uint64_t getFaceId () const
 
FaceQueryFilter & setFaceId (uint64_t faceId)
 
FaceQueryFilter & unsetFaceId ()
 
bool hasUriScheme () const
 
const std::string & getUriScheme () const
 
FaceQueryFilter & setUriScheme (const std::string &uriScheme)
 
FaceQueryFilter & unsetUriScheme ()
 
bool hasRemoteUri () const
 
const std::string & getRemoteUri () const
 
FaceQueryFilter & setRemoteUri (const std::string &remoteUri)
 
FaceQueryFilter & unsetRemoteUri ()
 
bool hasLocalUri () const
 
const std::string & getLocalUri () const
 
FaceQueryFilter & setLocalUri (const std::string &localUri)
 
FaceQueryFilter & unsetLocalUri ()
 
bool hasFaceScope () const
 
FaceScope getFaceScope () const
 
FaceQueryFilter & setFaceScope (FaceScope faceScope)
 
FaceQueryFilter & unsetFaceScope ()
 
bool hasFacePersistency () const
 
FacePersistency getFacePersistency () const
 
FaceQueryFilter & setFacePersistency (FacePersistency facePersistency)
 
FaceQueryFilter & unsetFacePersistency ()
 
bool hasLinkType () const
 
LinkType getLinkType () const
 
FaceQueryFilter & setLinkType (LinkType linkType)
 
FaceQueryFilter & unsetLinkType ()
 

Detailed Description

represents Face Query Filter

See also
https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Query-Operation

Definition at line 37 of file face-query-filter.hpp.

Constructor & Destructor Documentation

◆ FaceQueryFilter() [1/2]

ndn::nfd::FaceQueryFilter::FaceQueryFilter ( )
default

◆ FaceQueryFilter() [2/2]

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

Definition at line 38 of file face-query-filter.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

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

prepend FaceQueryFilter to the encoder

Definition at line 45 of file face-query-filter.cpp.

References ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceQueryFilter, ndn::tlv::nfd::FaceScope, hasLocalUri(), hasRemoteUri(), hasUriScheme(), ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::encoding::prependNonNegativeIntegerBlock(), ndn::encoding::prependStringBlock(), ndn::tlv::nfd::Uri, and ndn::tlv::nfd::UriScheme.

Referenced by ndn::nfd::FaceQueryDataset::FaceQueryDataset().

◆ wireEncode() [2/2]

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

encode FaceQueryFilter

Definition at line 89 of file face-query-filter.cpp.

References ndn::Block::hasWire().

◆ wireDecode()

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

decode FaceQueryFilter

Definition at line 105 of file face-query-filter.cpp.

References ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::nfd::FaceId, ndn::tlv::nfd::FacePersistency, ndn::tlv::nfd::FaceQueryFilter, ndn::tlv::nfd::FaceScope, ndn::tlv::nfd::LinkType, ndn::tlv::nfd::LocalUri, NDN_THROW, nonstd::optional_lite::nullopt, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::Block::type(), ndn::tlv::nfd::Uri, and ndn::tlv::nfd::UriScheme.

Referenced by FaceQueryFilter(), and nfd::matchFilter().

◆ empty()

bool ndn::nfd::FaceQueryFilter::empty ( ) const
Returns
whether the filter is empty

Definition at line 175 of file face-query-filter.cpp.

References hasFaceId(), hasFacePersistency(), hasFaceScope(), hasLinkType(), hasLocalUri(), hasRemoteUri(), and hasUriScheme().

◆ hasFaceId()

bool ndn::nfd::FaceQueryFilter::hasFaceId ( ) const
inline

Definition at line 74 of file face-query-filter.hpp.

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

◆ getFaceId()

uint64_t ndn::nfd::FaceQueryFilter::getFaceId ( ) const
inline

Definition at line 80 of file face-query-filter.hpp.

References hasFaceId(), setFaceId(), and unsetFaceId().

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

◆ setFaceId()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setFaceId ( uint64_t  faceId)

Definition at line 187 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getFaceId().

◆ unsetFaceId()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetFaceId ( )

Definition at line 195 of file face-query-filter.cpp.

References nonstd::optional_lite::nullopt, and ndn::Block::reset().

Referenced by getFaceId().

◆ hasUriScheme()

bool ndn::nfd::FaceQueryFilter::hasUriScheme ( ) const
inline

Definition at line 93 of file face-query-filter.hpp.

Referenced by empty(), getUriScheme(), nfd::matchFilter(), ndn::nfd::operator<<(), ndn::nfd::operator==(), and wireEncode().

◆ getUriScheme()

const std::string& ndn::nfd::FaceQueryFilter::getUriScheme ( ) const
inline

Definition at line 99 of file face-query-filter.hpp.

References hasUriScheme(), setUriScheme(), and unsetUriScheme().

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

◆ setUriScheme()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setUriScheme ( const std::string &  uriScheme)

Definition at line 203 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getUriScheme(), and unsetUriScheme().

◆ unsetUriScheme()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetUriScheme ( )

Definition at line 211 of file face-query-filter.cpp.

References setUriScheme().

Referenced by getUriScheme().

◆ hasRemoteUri()

bool ndn::nfd::FaceQueryFilter::hasRemoteUri ( ) const
inline

Definition at line 112 of file face-query-filter.hpp.

Referenced by empty(), getRemoteUri(), nfd::matchFilter(), ndn::nfd::operator<<(), ndn::nfd::operator==(), and wireEncode().

◆ getRemoteUri()

const std::string& ndn::nfd::FaceQueryFilter::getRemoteUri ( ) const
inline

Definition at line 118 of file face-query-filter.hpp.

References hasRemoteUri(), setRemoteUri(), and unsetRemoteUri().

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

◆ setRemoteUri()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setRemoteUri ( const std::string &  remoteUri)

Definition at line 217 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getRemoteUri(), and unsetRemoteUri().

◆ unsetRemoteUri()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetRemoteUri ( )

Definition at line 225 of file face-query-filter.cpp.

References setRemoteUri().

Referenced by getRemoteUri().

◆ hasLocalUri()

bool ndn::nfd::FaceQueryFilter::hasLocalUri ( ) const
inline

Definition at line 131 of file face-query-filter.hpp.

Referenced by empty(), getLocalUri(), nfd::matchFilter(), ndn::nfd::operator<<(), ndn::nfd::operator==(), and wireEncode().

◆ getLocalUri()

const std::string& ndn::nfd::FaceQueryFilter::getLocalUri ( ) const
inline

Definition at line 137 of file face-query-filter.hpp.

References hasLocalUri(), setLocalUri(), and unsetLocalUri().

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

◆ setLocalUri()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setLocalUri ( const std::string &  localUri)

Definition at line 231 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getLocalUri(), and unsetLocalUri().

◆ unsetLocalUri()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetLocalUri ( )

Definition at line 239 of file face-query-filter.cpp.

References setLocalUri().

Referenced by getLocalUri().

◆ hasFaceScope()

bool ndn::nfd::FaceQueryFilter::hasFaceScope ( ) const
inline

Definition at line 150 of file face-query-filter.hpp.

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

◆ getFaceScope()

FaceScope ndn::nfd::FaceQueryFilter::getFaceScope ( ) const
inline

Definition at line 156 of file face-query-filter.hpp.

References hasFaceScope(), setFaceScope(), and unsetFaceScope().

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

◆ setFaceScope()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setFaceScope ( FaceScope  faceScope)

Definition at line 245 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getFaceScope().

◆ unsetFaceScope()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetFaceScope ( )

Definition at line 253 of file face-query-filter.cpp.

References nonstd::optional_lite::nullopt, and ndn::Block::reset().

Referenced by getFaceScope().

◆ hasFacePersistency()

bool ndn::nfd::FaceQueryFilter::hasFacePersistency ( ) const
inline

Definition at line 169 of file face-query-filter.hpp.

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

◆ getFacePersistency()

FacePersistency ndn::nfd::FaceQueryFilter::getFacePersistency ( ) const
inline

Definition at line 175 of file face-query-filter.hpp.

References hasFacePersistency(), setFacePersistency(), and unsetFacePersistency().

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

◆ setFacePersistency()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setFacePersistency ( FacePersistency  facePersistency)

Definition at line 261 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getFacePersistency().

◆ unsetFacePersistency()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetFacePersistency ( )

Definition at line 269 of file face-query-filter.cpp.

References nonstd::optional_lite::nullopt, and ndn::Block::reset().

Referenced by getFacePersistency().

◆ hasLinkType()

bool ndn::nfd::FaceQueryFilter::hasLinkType ( ) const
inline

Definition at line 188 of file face-query-filter.hpp.

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

◆ getLinkType()

LinkType ndn::nfd::FaceQueryFilter::getLinkType ( ) const
inline

Definition at line 194 of file face-query-filter.hpp.

References hasLinkType(), ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(), ndn::nfd::operator==(), setLinkType(), and unsetLinkType().

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

◆ setLinkType()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::setLinkType ( LinkType  linkType)

Definition at line 277 of file face-query-filter.cpp.

References ndn::Block::reset().

Referenced by getLinkType().

◆ unsetLinkType()

FaceQueryFilter & ndn::nfd::FaceQueryFilter::unsetLinkType ( )

Definition at line 285 of file face-query-filter.cpp.

References nonstd::optional_lite::nullopt, and ndn::Block::reset().

Referenced by getLinkType().

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