ndn::InterestFilterHandle Class Reference

A handle of registered Interest filter. More...

#include <ndn-cxx/face.hpp>

+ Inheritance diagram for ndn::InterestFilterHandle:
+ Collaboration diagram for ndn::InterestFilterHandle:

Public Member Functions

 InterestFilterHandle () noexcept=default
 
 InterestFilterHandle (Face &face, const InterestFilterId *id)
 
void cancel () const
 Cancel the operation. More...
 
 operator const InterestFilterId * () const noexcept
 

Detailed Description

A handle of registered Interest filter.

InterestFilterHandle hdl = face.setInterestFilter(prefix, onInterest);
hdl.cancel(); // unset the Interest filter
Warning
Unsetting the same Interest filter more than once, using same or different InterestFilterHandle or ScopedInterestFilterHandle, may trigger undefined behavior.
Unsetting an Interest filter after the face has been destructed may trigger undefined behavior.

Definition at line 652 of file face.hpp.

Constructor & Destructor Documentation

ndn::InterestFilterHandle::InterestFilterHandle ( )
defaultnoexcept
ndn::InterestFilterHandle::InterestFilterHandle ( Face face,
const InterestFilterId *  id 
)

Definition at line 447 of file face.cpp.

Member Function Documentation

void ndn::detail::CancelHandle::cancel ( ) const
inherited

Cancel the operation.

Definition at line 33 of file cancel-handle.cpp.

ndn::InterestFilterHandle::operator const InterestFilterId * ( ) const
inlinenoexcept

Definition at line 659 of file face.hpp.