nfd::cs::lru::LruPolicy Class Reference

Least-Recently-Used (LRU) replacement policy. More...

#include <daemon/table/cs-policy-lru.hpp>

Inheritance diagram for nfd::cs::lru::LruPolicy:

Collaboration diagram for nfd::cs::lru::LruPolicy:

Public Types
using	EntryRef = Table::const_iterator
	a reference to an CS entry More...

Public Member Functions
	LruPolicy ()
void	afterInsert (EntryRef i)
	invoked by CS after a new entry is inserted More...
void	afterRefresh (EntryRef i)
	invoked by CS after an existing entry is refreshed by same Data More...
void	beforeErase (EntryRef i)
	invoked by CS before an entry is erased due to management command More...
void	beforeUse (EntryRef i)
	invoked by CS before an entry is used to match a lookup More...
Cs *	getCs () const
	gets cs More...
size_t	getLimit () const
	gets hard limit (in number of entries) More...
const std::string &	getName () const
void	setCs (Cs *cs)
	sets cs More...
void	setLimit (size_t nMaxEntries)
	sets hard limit (in number of entries) More...

Static Public Member Functions
static unique_ptr< Policy >	create (const std::string &policyName)
static std::set< std::string >	getPolicyNames ()
template<typename P >
static void	registerPolicy (const std::string &policyName=P::POLICY_NAME)

Public Attributes
signal::Signal< Policy, EntryRef >	beforeEvict
	emits when an entry is being evicted More...

Static Public Attributes
static const std::string	POLICY_NAME = "lru"

Detailed Description

Least-Recently-Used (LRU) replacement policy.

Definition at line 49 of file cs-policy-lru.hpp.

Member Typedef Documentation

EntryRef

using nfd::cs::Policy::EntryRef = Table::const_iterator

inherited

a reference to an CS entry

Note

operator< of EntryRef compares the Data name enclosed in the Entry.

Definition at line 111 of file cs-policy.hpp.

Constructor & Destructor Documentation

LruPolicy()

nfd::cs::lru::LruPolicy::LruPolicy

(

)

Definition at line 36 of file cs-policy-lru.cpp.

Member Function Documentation

afterInsert()

void nfd::cs::Policy::afterInsert ( EntryRef  i )

inherited

invoked by CS after a new entry is inserted

Postcondition

cs.size() <= getLimit()

The policy may evict entries if necessary. During this process, i might be evicted.

Definition at line 76 of file cs-policy.cpp.

afterRefresh()

void nfd::cs::Policy::afterRefresh ( EntryRef  i )

inherited

invoked by CS after an existing entry is refreshed by same Data

The policy may witness this refresh to make better eviction decisions in the future.

Definition at line 83 of file cs-policy.cpp.

beforeErase()

void nfd::cs::Policy::beforeErase ( EntryRef  i )

inherited

invoked by CS before an entry is erased due to management command

Warning

CS must not invoke this method if an entry is erased due to eviction.

Definition at line 90 of file cs-policy.cpp.

beforeUse()

void nfd::cs::Policy::beforeUse ( EntryRef  i )

inherited

invoked by CS before an entry is used to match a lookup

The policy may witness this usage to make better eviction decisions in the future.

Definition at line 97 of file cs-policy.cpp.

create()

unique_ptr< Policy > nfd::cs::Policy::create ( const std::string &  policyName )

staticinherited

Returns

a cs::Policy identified by policyName, or nullptr if policyName is unknown

Definition at line 46 of file cs-policy.cpp.

getCs()

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

inlineinherited

gets cs

Definition at line 77 of file cs-policy.hpp.

getLimit()

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

inlineinherited

gets hard limit (in number of entries)

Definition at line 93 of file cs-policy.hpp.

getName()

const std::string& nfd::cs::Policy::getName ( ) const

inlineinherited

Definition at line 69 of file cs-policy.hpp.

getPolicyNames()

std::set< std::string > nfd::cs::Policy::getPolicyNames ( )

staticinherited

Returns

a list of available policy names

Definition at line 54 of file cs-policy.cpp.

registerPolicy()

template<typename P >

static void nfd::cs::Policy::registerPolicy ( const std::string &  policyName = P::POLICY_NAME )

inlinestaticinherited

Definition at line 43 of file cs-policy.hpp.

setCs()

void nfd::cs::Policy::setCs ( Cs *  cs )

inlineinherited

sets cs

Definition at line 85 of file cs-policy.hpp.

setLimit()

void nfd::cs::Policy::setLimit ( size_t  nMaxEntries )

inherited

sets hard limit (in number of entries)

Postcondition

getLimit() == nMaxEntries

cs.size() <= getLimit()

The policy may evict entries if necessary.

Definition at line 68 of file cs-policy.cpp.

Member Data Documentation

beforeEvict

signal::Signal<Policy, EntryRef> nfd::cs::Policy::beforeEvict

inherited

emits when an entry is being evicted

A policy implementation should emit this signal to cause CS to erase an entry from its index. CS should connect to this signal and erase the entry upon signal emission.

Definition at line 118 of file cs-policy.hpp.

POLICY_NAME

const std::string nfd::cs::lru::LruPolicy::POLICY_NAME = "lru"

static

Definition at line 55 of file cs-policy-lru.hpp.