ndn::RecordContainer< T > Class Template Reference

Container of PendingInterest, RegisteredPrefix, or InterestFilterRecord. More...

#include <record-container.hpp>

Inheritance diagram for ndn::RecordContainer< T >:

Collaboration diagram for ndn::RecordContainer< T >:

Public Types
using	Record = T
using	Container = std::map< RecordId, Record >

Public Member Functions
Record *	get (RecordId id)
	Retrieve record by ID. More...
template<typename ... TArgs>
Record &	put (RecordId id, TArgs &&... args)
	Insert a record with given ID. More...
RecordId	allocateId ()
template<typename ... TArgs>
Record &	insert (TArgs &&... args)
	Insert a record with newly assigned ID. More...
void	erase (RecordId id)
void	clear ()
template<typename Visitor >
void	removeIf (const Visitor &f)
	Visit all records with the option to erase. More...
template<typename Visitor >
void	forEach (const Visitor &f)
	Visit all records. More...
NDN_CXX_NODISCARD bool	empty () const noexcept
size_t	size () const noexcept

Public Attributes
util::Signal< RecordContainer< T > >	onEmpty
	Signals when container becomes empty. More...

Detailed Description

template<typename T>
class ndn::RecordContainer< T >

Container of PendingInterest, RegisteredPrefix, or InterestFilterRecord.

Template Parameters

T	record type

Definition at line 35 of file record-container.hpp.

Member Typedef Documentation

Record

template<typename T >

using ndn::RecordContainer< T >::Record = T

Definition at line 76 of file record-container.hpp.

Container

template<typename T >

using ndn::RecordContainer< T >::Container = std::map<RecordId, Record>

Definition at line 77 of file record-container.hpp.

Member Function Documentation

get()

template<typename T >

Record* ndn::RecordContainer< T >::get ( RecordId  id )

inline

Retrieve record by ID.

Definition at line 82 of file record-container.hpp.

Referenced by ndn::Face::Impl::asyncUnregisterPrefix(), and ndn::Face::Impl::asyncUnsetInterestFilter().

put()

template<typename T >

template<typename ... TArgs>

Record& ndn::RecordContainer< T >::put ( RecordId  id, TArgs &&...  args  )

inline

Insert a record with given ID.

Definition at line 95 of file record-container.hpp.

Referenced by ndn::Face::Impl::asyncExpressInterest(), ndn::Face::Impl::asyncSetInterestFilter(), ndn::RecordContainer< PendingInterest >::insert(), and ndn::Face::Impl::registerPrefix().

allocateId()

template<typename T >

RecordId ndn::RecordContainer< T >::allocateId ( )

inline

Definition at line 109 of file record-container.hpp.

Referenced by ndn::RecordContainer< PendingInterest >::insert(), and ndn::Face::Impl::registerPrefix().

insert()

template<typename T >

template<typename ... TArgs>

Record& ndn::RecordContainer< T >::insert ( TArgs &&...  args )

inline

Insert a record with newly assigned ID.

Definition at line 118 of file record-container.hpp.

Referenced by ndn::Face::Impl::processIncomingInterest(), and ndn::Face::Impl::registerPrefix().

erase()

template<typename T >

void ndn::RecordContainer< T >::erase ( RecordId  id )

inline

Definition at line 124 of file record-container.hpp.

Referenced by ndn::Face::Impl::asyncRemovePendingInterest(), ndn::Face::Impl::asyncUnregisterPrefix(), and ndn::Face::Impl::asyncUnsetInterestFilter().

clear()

template<typename T >

void ndn::RecordContainer< T >::clear ( )

inline

Definition at line 133 of file record-container.hpp.

Referenced by ndn::Face::Impl::asyncRemoveAllPendingInterests(), and ndn::Face::Impl::shutdown().

removeIf()

template<typename T >

template<typename Visitor >

void ndn::RecordContainer< T >::removeIf ( const Visitor &  f )

inline

Visit all records with the option to erase.

Template Parameters

Visitor

function of type 'bool f(Record& record)'

Parameters

f	visitor function, return true to erase record

Definition at line 145 of file record-container.hpp.

Referenced by ndn::RecordContainer< PendingInterest >::forEach(), ndn::Face::Impl::nackPendingInterests(), and ndn::Face::Impl::satisfyPendingInterests().

forEach()

template<typename T >

template<typename Visitor >

void ndn::RecordContainer< T >::forEach ( const Visitor &  f )

inline

Visit all records.

Template Parameters

Visitor

function of type 'void f(Record& record)'

Parameters

f	visitor function

Definition at line 167 of file record-container.hpp.

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

empty()

template<typename T >

NDN_CXX_NODISCARD bool ndn::RecordContainer< T >::empty ( ) const

inlinenoexcept

Definition at line 176 of file record-container.hpp.

Referenced by ndn::RecordContainer< PendingInterest >::erase(), ndn::Face::Impl::onEmptyPitOrNoRegisteredPrefixes(), and ndn::RecordContainer< PendingInterest >::removeIf().

size()

template<typename T >

size_t ndn::RecordContainer< T >::size ( ) const

inlinenoexcept

Definition at line 182 of file record-container.hpp.

Member Data Documentation

onEmpty

template<typename T >

util::Signal<RecordContainer<T> > ndn::RecordContainer< T >::onEmpty

Signals when container becomes empty.

Definition at line 190 of file record-container.hpp.

Referenced by ndn::RecordContainer< PendingInterest >::clear(), ndn::RecordContainer< PendingInterest >::erase(), ndn::Face::Impl::Impl(), and ndn::RecordContainer< PendingInterest >::removeIf().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/impl/record-container.hpp