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

Associates an InterestFilter with an Interest callback. More...

#include <interest-filter-record.hpp>

Inheritance diagram for ndn::InterestFilterRecord:
Collaboration diagram for ndn::InterestFilterRecord:

Public Member Functions

 InterestFilterRecord (const InterestFilter &filter, const InterestCallback &callback)
 Construct an Interest filter record. More...
 
const InterestFiltergetFilter () const
 
bool doesMatch (const PendingInterest &entry) const
 Check if Interest name matches the filter. More...
 
void invokeInterestCallback (const Interest &interest) const
 invokes the InterestCallback More...
 
- Public Member Functions inherited from ndn::detail::RecordBase< InterestFilterRecord >
RecordId getId () const
 

Additional Inherited Members

- Protected Member Functions inherited from ndn::detail::RecordBase< InterestFilterRecord >
 ~RecordBase ()=default
 
void deleteSelf ()
 Delete this record from the container. More...
 

Detailed Description

Associates an InterestFilter with an Interest callback.

Definition at line 33 of file interest-filter-record.hpp.

Constructor & Destructor Documentation

◆ InterestFilterRecord()

ndn::InterestFilterRecord::InterestFilterRecord ( const InterestFilter filter,
const InterestCallback callback 
)
inline

Construct an Interest filter record.

Parameters
filteran InterestFilter that represents what Interest should invoke the callback
callbackinvoked when matching Interest is received

Definition at line 42 of file interest-filter-record.hpp.

Member Function Documentation

◆ getFilter()

const InterestFilter& ndn::InterestFilterRecord::getFilter ( ) const
inline

Definition at line 49 of file interest-filter-record.hpp.

Referenced by ndn::Face::Impl::shutdown().

◆ doesMatch()

bool ndn::InterestFilterRecord::doesMatch ( const PendingInterest entry) const
inline

◆ invokeInterestCallback()

void ndn::InterestFilterRecord::invokeInterestCallback ( const Interest interest) const
inline

invokes the InterestCallback

Note
This method does nothing if the Interest callback is empty

Definition at line 70 of file interest-filter-record.hpp.

Referenced by ndn::Face::Impl::shutdown().


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