NFD: Named Data Networking Forwarding Daemon 24.07-28-gdcc0e6e0
Loading...
Searching...
No Matches
cs-policy.cpp
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2014-2022, Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
26#include "cs-policy.hpp"
27#include "cs.hpp"
28#include "common/logger.hpp"
29
30#include <boost/range/adaptor/map.hpp>
31#include <boost/range/algorithm/copy.hpp>
32
33NFD_LOG_INIT(CsPolicy);
34
35namespace nfd::cs {
36
37Policy::Registry&
38Policy::getRegistry()
39{
40 static Registry registry;
41 return registry;
42}
43
44unique_ptr<Policy>
45Policy::create(const std::string& policyName)
46{
47 Registry& registry = getRegistry();
48 auto i = registry.find(policyName);
49 return i == registry.end() ? nullptr : i->second();
50}
51
52std::set<std::string>
54{
55 std::set<std::string> policyNames;
56 boost::copy(getRegistry() | boost::adaptors::map_keys,
57 std::inserter(policyNames, policyNames.end()));
58 return policyNames;
59}
60
61Policy::Policy(std::string_view policyName)
62 : m_policyName(policyName)
63{
64}
65
66void
67Policy::setLimit(size_t nMaxEntries)
68{
69 NFD_LOG_INFO("setLimit " << nMaxEntries);
70 m_limit = nMaxEntries;
71 this->evictEntries();
72}
73
74void
76{
77 BOOST_ASSERT(m_cs != nullptr);
78 this->doAfterInsert(i);
79}
80
81void
83{
84 BOOST_ASSERT(m_cs != nullptr);
85 this->doAfterRefresh(i);
86}
87
88void
90{
91 BOOST_ASSERT(m_cs != nullptr);
92 this->doBeforeErase(i);
93}
94
95void
97{
98 BOOST_ASSERT(m_cs != nullptr);
99 this->doBeforeUse(i);
100}
101
102} // namespace nfd::cs
virtual void doAfterInsert(EntryRef i)=0
Invoked after a new entry is created in CS.
virtual void doAfterRefresh(EntryRef i)=0
Invoked after an existing entry is refreshed by same Data.
void setLimit(size_t nMaxEntries)
Sets hard limit (in number of entries).
Definition cs-policy.cpp:67
void beforeUse(EntryRef i)
Invoked by CS before an entry is used to match a lookup.
Definition cs-policy.cpp:96
void afterInsert(EntryRef i)
Invoked by CS after a new entry is inserted.
Definition cs-policy.cpp:75
static std::set< std::string > getPolicyNames()
Returns a list of available policy names.
Definition cs-policy.cpp:53
static unique_ptr< Policy > create(const std::string &policyName)
Returns a cs::Policy identified by policyName, or nullptr if policyName is unknown.
Definition cs-policy.cpp:45
virtual void evictEntries()=0
Evicts zero or more entries.
virtual void doBeforeErase(EntryRef i)=0
Invoked before an entry is erased due to management command.
virtual void doBeforeUse(EntryRef i)=0
Invoked before an entry is used to match a lookup.
void beforeErase(EntryRef i)
Invoked by CS before an entry is erased due to management command.
Definition cs-policy.cpp:89
Policy(std::string_view policyName)
Definition cs-policy.cpp:61
Table::const_iterator EntryRef
A reference to a CS entry.
void afterRefresh(EntryRef i)
Invoked by CS after an existing entry is refreshed by same Data.
Definition cs-policy.cpp:82
#define NFD_LOG_INFO
Definition logger.hpp:39
#define NFD_LOG_INIT(name)
Definition logger.hpp:31