nfd::strategy_choice::StrategyChoice Class Reference

represents the Strategy Choice table More...

#include <daemon/table/strategy-choice.hpp>

+ Inheritance diagram for nfd::strategy_choice::StrategyChoice:
+ Collaboration diagram for nfd::strategy_choice::StrategyChoice:

Classes

class  InsertResult
 

Public Types

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

Public Member Functions

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

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

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

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

Constructor & Destructor Documentation

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

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

Member Function Documentation

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 157 of file strategy-choice.hpp.

const_iterator nfd::strategy_choice::StrategyChoice::end ( ) const
inline
Returns
an iterator to the end
See also
begin()

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

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 140 of file strategy-choice.cpp.

Strategy & nfd::strategy_choice::StrategyChoice::findEffectiveStrategy ( const Name &  prefix) const

get effective strategy for prefix

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

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 196 of file strategy-choice.cpp.

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 202 of file strategy-choice.cpp.

template<typename K >
Strategy& nfd::strategy_choice::StrategyChoice::findEffectiveStrategyImpl ( const K &  key) const

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

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 165 of file strategy-choice.cpp.

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

set strategy of prefix to be strategyName

Parameters
prefixthe name prefix to change strategy
strategyNamestrategy 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 70 of file strategy-choice.cpp.

void nfd::strategy_choice::StrategyChoice::setDefaultStrategy ( const Name &  strategyName)

set the default strategy

This must be called by forwarder constructor.

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

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

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