nfd::cs::Cs Class Reference

implements the Content Store More...

#include <cs.hpp>

Inheritance diagram for nfd::cs::Cs:

Collaboration diagram for nfd::cs::Cs:

Public Types
using	const_iterator = Table::const_iterator

Public Member Functions
	Cs (size_t nMaxPackets=10)
void	insert (const Data &data, bool isUnsolicited=false)
	inserts a Data packet More...
template<typename AfterEraseCallback >
void	erase (const Name &prefix, size_t limit, AfterEraseCallback &&cb)
	asynchronously erases entries under prefix More...
template<typename HitCallback , typename MissCallback >
void	find (const Interest &interest, HitCallback &&hit, MissCallback &&miss) const
	finds the best matching Data packet More...
size_t	size () const
	get number of stored packets More...
size_t	getLimit () const
	get capacity (in number of packets) More...
void	setLimit (size_t nMaxPackets)
	change capacity (in number of packets) More...
Policy *	getPolicy () const
	get replacement policy More...
void	setPolicy (unique_ptr< Policy > policy)
	change replacement policy More...
bool	shouldAdmit () const
	get CS_ENABLE_ADMIT flag More...
void	enableAdmit (bool shouldAdmit)
	set CS_ENABLE_ADMIT flag More...
bool	shouldServe () const
	get CS_ENABLE_SERVE flag More...
void	enableServe (bool shouldServe)
	set CS_ENABLE_SERVE flag More...
const_iterator	begin () const
const_iterator	end () const

Detailed Description

implements the Content Store

This Content Store implementation consists of a Table and a replacement policy.

The Table is a container ( std::set ) sorted by full Names of stored Data packets. Data packets are wrapped in Entry objects. Each Entry contains the Data packet itself, and a few additional attributes such as when the Data becomes non-fresh.

The replacement policy is implemented in a subclass of Policy.

Definition at line 44 of file cs.hpp.

Member Typedef Documentation

const_iterator

using nfd::cs::Cs::const_iterator = Table::const_iterator

Definition at line 161 of file cs.hpp.

Constructor & Destructor Documentation

Cs()

nfd::cs::Cs::Cs ( size_t  nMaxPackets = 10 )

explicit

Definition at line 44 of file cs.cpp.

References nfd::cs::makeDefaultPolicy().

Member Function Documentation

insert()

void nfd::cs::Cs::insert	(	const Data &	data,
		bool	isUnsolicited = false
	)

inserts a Data packet

Definition at line 51 of file cs.cpp.

References nfd::cs::Entry::clearUnsolicited(), ndn::SimpleTag< T, TypeId >::get(), ndn::Data::getName(), ndn::TagHost::getTag(), nfd::cs::Entry::isUnsolicited(), NFD_LOG_DEBUG, and nfd::cs::Entry::updateFreshUntil().

erase()

template<typename AfterEraseCallback >

void nfd::cs::Cs::erase ( const Name &  prefix, size_t  limit, AfterEraseCallback &&  cb  )

inline

asynchronously erases entries under prefix

Template Parameters

AfterEraseCallback

void f(size_t nErased)

Parameters

prefix	name prefix of entries
limit	max number of entries to erase
cb	callback to receive the actual number of erased entries; must not be empty; it may be invoked either before or after erase() returns

Definition at line 64 of file cs.hpp.

find()

template<typename HitCallback , typename MissCallback >

void nfd::cs::Cs::find ( const Interest &  interest, HitCallback &&  hit, MissCallback &&  miss  ) const

inline

finds the best matching Data packet

Template Parameters

HitCallback	void f(const Interest&, const Data&)
MissCallback	void f(const Interest&)

Parameters

interest	the Interest for lookup
hit	a callback if a match is found; must not be empty
miss	a callback if there's no match; must not be empty

Note

A lookup invokes either callback exactly once. The callback may be invoked either before or after find() returns

Definition at line 81 of file cs.hpp.

size()

size_t nfd::cs::Cs::size ( ) const

inline

get number of stored packets

Definition at line 94 of file cs.hpp.

getLimit()

size_t nfd::cs::Cs::getLimit ( ) const

inline

get capacity (in number of packets)

Definition at line 103 of file cs.hpp.

setLimit()

void nfd::cs::Cs::setLimit ( size_t  nMaxPackets )

inline

change capacity (in number of packets)

Definition at line 111 of file cs.hpp.

Referenced by nfd::TablesConfigSection::ensureConfigured().

getPolicy()

Policy* nfd::cs::Cs::getPolicy ( ) const

inline

get replacement policy

Definition at line 119 of file cs.hpp.

setPolicy()

void nfd::cs::Cs::setPolicy

(

unique_ptr< Policy >

policy

)

change replacement policy

Precondition

size() == 0

Definition at line 144 of file cs.cpp.

References nonstd::optional_lite::std11::move().

shouldAdmit()

bool nfd::cs::Cs::shouldAdmit ( ) const

inline

get CS_ENABLE_ADMIT flag

See also

https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config

Definition at line 134 of file cs.hpp.

Referenced by enableAdmit().

enableAdmit()

void nfd::cs::Cs::enableAdmit

(

bool

shouldAdmit

)

set CS_ENABLE_ADMIT flag

See also

https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config

Definition at line 165 of file cs.cpp.

References NFD_LOG_INFO, and shouldAdmit().

shouldServe()

bool nfd::cs::Cs::shouldServe ( ) const

inline

get CS_ENABLE_SERVE flag

See also

https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config

Definition at line 149 of file cs.hpp.

Referenced by enableServe().

enableServe()

void nfd::cs::Cs::enableServe

(

bool

shouldServe

)

set CS_ENABLE_SERVE flag

See also

https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config

Definition at line 175 of file cs.cpp.

References NFD_LOG_INFO, and shouldServe().

begin()

const_iterator nfd::cs::Cs::begin ( ) const

inline

Definition at line 164 of file cs.hpp.

end()

const_iterator nfd::cs::Cs::end ( ) const

inline

Definition at line 170 of file cs.hpp.

---

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

• ndnSIM/NFD/daemon/table/cs.hpp
• ndnSIM/NFD/daemon/table/cs.cpp