blob: a47337f8f74006f66ce05512a0d502a1145ef25e [file] [log] [blame]
Junxiao Shibb5105f2014-03-03 12:06:45 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento50a6af32019-02-21 00:04:40 -05002/*
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -04003 * Copyright (c) 2014-2022, Regents of the University of California,
Junxiao Shib184e532016-05-26 18:09:57 +00004 * 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.
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070010 *
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/>.
Junxiao Shib184e532016-05-26 18:09:57 +000024 */
Junxiao Shibb5105f2014-03-03 12:06:45 -070025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_DAEMON_TABLE_STRATEGY_CHOICE_ENTRY_HPP
27#define NFD_DAEMON_TABLE_STRATEGY_CHOICE_ENTRY_HPP
Junxiao Shibb5105f2014-03-03 12:06:45 -070028
Junxiao Shi9f5b01d2016-08-05 03:54:28 +000029#include "core/common.hpp"
Junxiao Shibb5105f2014-03-03 12:06:45 -070030
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040031namespace nfd::fw {
Junxiao Shibb5105f2014-03-03 12:06:45 -070032class Strategy;
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040033} // namespace nfd::fw
Junxiao Shi340d5532016-08-13 04:00:35 +000034
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040035namespace nfd::name_tree {
Junxiao Shi2570f3e2016-07-27 02:48:29 +000036class Entry;
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040037} // namespace nfd::name_tree
Junxiao Shibb5105f2014-03-03 12:06:45 -070038
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040039namespace nfd::strategy_choice {
Junxiao Shibb5105f2014-03-03 12:06:45 -070040
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040041/**
42 * \brief Represents an entry in the %Strategy %Choice table.
43 * \sa StrategyChoice
Junxiao Shibb5105f2014-03-03 12:06:45 -070044 */
45class Entry : noncopyable
46{
47public:
Davide Pesavento50a6af32019-02-21 00:04:40 -050048 explicit
Junxiao Shibb5105f2014-03-03 12:06:45 -070049 Entry(const Name& prefix);
50
Junxiao Shif15058a2016-12-11 20:15:05 +000051 ~Entry();
52
Junxiao Shi4cb74312016-12-25 20:48:47 +000053 /** \return name prefix on which this strategy choice is applied
54 */
Junxiao Shibb5105f2014-03-03 12:06:45 -070055 const Name&
Junxiao Shi340d5532016-08-13 04:00:35 +000056 getPrefix() const
57 {
58 return m_prefix;
59 }
Junxiao Shibb5105f2014-03-03 12:06:45 -070060
Junxiao Shi4cb74312016-12-25 20:48:47 +000061 /** \return strategy instance name
62 */
Junxiao Shib5888d22014-05-26 07:35:22 -070063 const Name&
Junxiao Shi4cb74312016-12-25 20:48:47 +000064 getStrategyInstanceName() const;
Junxiao Shib5888d22014-05-26 07:35:22 -070065
Junxiao Shi4cb74312016-12-25 20:48:47 +000066 /** \return strategy instance
67 */
Junxiao Shibb5105f2014-03-03 12:06:45 -070068 fw::Strategy&
Junxiao Shi340d5532016-08-13 04:00:35 +000069 getStrategy() const
70 {
Junxiao Shi7f566dd2016-12-27 02:28:31 +000071 BOOST_ASSERT(m_strategy != nullptr);
72 return *m_strategy;
Junxiao Shi340d5532016-08-13 04:00:35 +000073 }
Junxiao Shibb5105f2014-03-03 12:06:45 -070074
Junxiao Shif15058a2016-12-11 20:15:05 +000075 void
76 setStrategy(unique_ptr<fw::Strategy> strategy);
Junxiao Shibb5105f2014-03-03 12:06:45 -070077
78private:
79 Name m_prefix;
Junxiao Shif15058a2016-12-11 20:15:05 +000080 unique_ptr<fw::Strategy> m_strategy;
Junxiao Shibb5105f2014-03-03 12:06:45 -070081
Davide Pesavento50a6af32019-02-21 00:04:40 -050082 name_tree::Entry* m_nameTreeEntry = nullptr;
Davide Pesaventoa3a7a4e2022-05-29 16:06:22 -040083 friend name_tree::Entry;
Junxiao Shibb5105f2014-03-03 12:06:45 -070084};
85
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040086} // namespace nfd::strategy_choice
Junxiao Shibb5105f2014-03-03 12:06:45 -070087
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070088#endif // NFD_DAEMON_TABLE_STRATEGY_CHOICE_ENTRY_HPP