NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::InterestFilterHandle Class Reference

A handle of registered Interest filter. More...

#include <face.hpp>

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

Public Member Functions

 InterestFilterHandle () noexcept=default
 InterestFilterHandle (Face &face, const InterestFilterId *id)
 operator const InterestFilterId * () const noexcept
- Public Member Functions inherited from ndn::detail::CancelHandle
 CancelHandle () noexcept=default
 CancelHandle (function< void()> cancel)
void cancel () const
 Cancel the operation. More...

Detailed Description

A handle of registered Interest filter.

InterestFilterHandle hdl = face.setInterestFilter(prefix, onInterest);
hdl.cancel(); // unset the Interest filter
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 599 of file face.hpp.

Constructor & Destructor Documentation

◆ InterestFilterHandle() [1/2]

ndn::InterestFilterHandle::InterestFilterHandle ( )

◆ InterestFilterHandle() [2/2]

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

Definition at line 371 of file face.cpp.

References ndn::Face::unsetInterestFilter().

Member Function Documentation

◆ operator const InterestFilterId *()

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

Definition at line 606 of file face.hpp.

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