nfd::strategy_choice::StrategyChoice Class Reference

represents the Strategy Choice table More...

#include <strategy-choice.hpp>

Inheritance diagram for nfd::strategy_choice::StrategyChoice:

Collaboration diagram for nfd::strategy_choice::StrategyChoice:

Classes
class	InsertResult

Public Types
typedef boost::transformed_range< name_tree::GetTableEntry< Entry >, const name_tree::Range >	Range
typedef boost::range_iterator< Range >::type	const_iterator

Public Member Functions
	StrategyChoice (Forwarder &forwarder)
size_t	size () const
void	setDefaultStrategy (const Name &strategyName)
	set the default strategy More...
InsertResult	insert (const Name &prefix, const Name &strategyName)
	set strategy of prefix to be strategyName More...
void	erase (const Name &prefix)
	make prefix to inherit strategy from its parent More...
std::pair< bool, Name >	get (const Name &prefix) const
	get strategy Name of prefix More...
fw::Strategy &	findEffectiveStrategy (const Name &prefix) const
	get effective strategy for prefix More...
fw::Strategy &	findEffectiveStrategy (const pit::Entry &pitEntry) const
	get effective strategy for pitEntry More...
fw::Strategy &	findEffectiveStrategy (const measurements::Entry &measurementsEntry) const
	get effective strategy for measurementsEntry More...
const_iterator	begin () const
const_iterator	end () const
template<typename K >
Strategy &	findEffectiveStrategyImpl (const K &key) const

Detailed Description

represents the Strategy Choice table

The Strategy Choice table maintains available Strategy types, and associates Name prefixes with Strategy types.

Each strategy is identified by a strategyName. It's recommended to include a version number as the last component of strategyName.

A Name prefix is owned by a strategy if a longest prefix match on the Strategy Choice table returns that strategy.

Definition at line 51 of file strategy-choice.hpp.

Member Typedef Documentation

Range

typedef boost::transformed_range<name_tree::GetTableEntry<Entry>, const name_tree::Range> nfd::strategy_choice::StrategyChoice::Range

Definition at line 156 of file strategy-choice.hpp.

const_iterator

typedef boost::range_iterator<Range>::type nfd::strategy_choice::StrategyChoice::const_iterator

Definition at line 157 of file strategy-choice.hpp.

Constructor & Destructor Documentation

StrategyChoice()

nfd::strategy_choice::StrategyChoice::StrategyChoice ( Forwarder &  forwarder )

explicit

Definition at line 50 of file strategy-choice.cpp.

Member Function Documentation

size()

size_t nfd::strategy_choice::StrategyChoice::size ( ) const

inline

Definition at line 58 of file strategy-choice.hpp.

setDefaultStrategy()

void nfd::strategy_choice::StrategyChoice::setDefaultStrategy

(

const Name &

strategyName

)

set the default strategy

This must be called by forwarder constructor.

Definition at line 58 of file strategy-choice.cpp.

References nfd::fw::Strategy::create(), nfd::name_tree::NameTree::lookup(), ns3::ndn::Name, NFD_LOG_INFO, and nfd::name_tree::Entry::setStrategyChoiceEntry().

Referenced by nfd::Forwarder::Forwarder().

insert()

StrategyChoice::InsertResult nfd::strategy_choice::StrategyChoice::insert	(	const Name &	prefix,
		const Name &	strategyName
	)

set strategy of prefix to be strategyName

Parameters

prefix	the name prefix to change strategy
strategyName	strategy instance name, may contain version and parameters; strategy must have been registered

Returns

convertible to true on success; convertible to false on failure

Definition at line 72 of file strategy-choice.cpp.

References nfd::fw::Strategy::create(), findEffectiveStrategy(), nfd::fw::Strategy::getInstanceName(), nfd::name_tree::NameTree::getMaxDepth(), nfd::strategy_choice::Entry::getStrategy(), nfd::name_tree::Entry::getStrategyChoiceEntry(), nfd::strategy_choice::Entry::getStrategyInstanceName(), nfd::name_tree::NameTree::lookup(), NFD_LOG_ERROR, NFD_LOG_TRACE, nfd::strategy_choice::Entry::setStrategy(), nfd::name_tree::Entry::setStrategyChoiceEntry(), and ndn::Name::size().

erase()

void nfd::strategy_choice::StrategyChoice::erase

(

const Name &

prefix

)

make prefix to inherit strategy from its parent

not allowed for root prefix (ndn:/)

Definition at line 142 of file strategy-choice.cpp.

References nfd::name_tree::NameTree::eraseIfEmpty(), findEffectiveStrategy(), nfd::name_tree::NameTree::findExactMatch(), ndn::Name::getPrefix(), nfd::strategy_choice::Entry::getStrategy(), and ndn::Name::size().

get()

std::pair< bool, Name > nfd::strategy_choice::StrategyChoice::get

(

const Name &

prefix

)

const

get strategy Name of prefix

Returns

true and strategyName at exact match, or false

Definition at line 167 of file strategy-choice.cpp.

References nfd::name_tree::NameTree::findExactMatch(), nfd::name_tree::Entry::getStrategyChoiceEntry(), nfd::strategy_choice::Entry::getStrategyInstanceName(), and ns3::ndn::Name.

findEffectiveStrategy() [1/3]

Strategy & nfd::strategy_choice::StrategyChoice::findEffectiveStrategy

(

const Name &

prefix

)

const

get effective strategy for prefix

Definition at line 192 of file strategy-choice.cpp.

Referenced by erase(), and insert().

findEffectiveStrategy() [2/3]

Strategy & nfd::strategy_choice::StrategyChoice::findEffectiveStrategy

(

const pit::Entry &

pitEntry

)

const

get effective strategy for pitEntry

This is equivalent to .findEffectiveStrategy(pitEntry.getName())

Definition at line 198 of file strategy-choice.cpp.

findEffectiveStrategy() [3/3]

Strategy & nfd::strategy_choice::StrategyChoice::findEffectiveStrategy

(

const measurements::Entry &

measurementsEntry

)

const

get effective strategy for measurementsEntry

This is equivalent to .findEffectiveStrategy(measurementsEntry.getName())

Definition at line 204 of file strategy-choice.cpp.

begin()

const_iterator nfd::strategy_choice::StrategyChoice::begin ( ) const

inline

Returns

an iterator to the beginning

Note

Iteration order is implementation-defined.

Warning

Undefined behavior may occur if a FIB/PIT/Measurements/StrategyChoice entry is inserted or erased during enumeration.

Definition at line 165 of file strategy-choice.hpp.

end()

const_iterator nfd::strategy_choice::StrategyChoice::end ( ) const

inline

Returns

an iterator to the end

See also

begin()

Definition at line 174 of file strategy-choice.hpp.

findEffectiveStrategyImpl()

template<typename K >

Strategy& nfd::strategy_choice::StrategyChoice::findEffectiveStrategyImpl

(

const K &

key

)

const

Definition at line 184 of file strategy-choice.cpp.

References nfd::name_tree::NameTree::findLongestPrefixMatch(), nfd::strategy_choice::Entry::getStrategy(), nfd::name_tree::Entry::getStrategyChoiceEntry(), and nfd::strategy_choice::nteHasStrategyChoiceEntry().

---

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

• ndnSIM/NFD/daemon/table/strategy-choice.hpp
• ndnSIM/NFD/daemon/table/strategy-choice.cpp