readvertise-policy.hpp
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 #ifndef NFD_DAEMON_RIB_READVERTISE_READVERTISE_POLICY_HPP
27 #define NFD_DAEMON_RIB_READVERTISE_READVERTISE_POLICY_HPP
28 
29 #include "rib/rib.hpp"
30 
31 #include <ndn-cxx/security/signing-info.hpp>
32 
33 namespace nfd::rib {
34 
38 {
39  Name prefix;
40  ndn::security::SigningInfo signer;
41 };
42 
45 class ReadvertisePolicy : noncopyable
46 {
47 public:
48  virtual
49  ~ReadvertisePolicy() = default;
50 
53  virtual std::optional<ReadvertiseAction>
54  handleNewRoute(const RibRouteRef& ribRoute) const = 0;
55 
58  virtual time::milliseconds
59  getRefreshInterval() const = 0;
60 };
61 
62 } // namespace nfd::rib
63 
64 #endif // NFD_DAEMON_RIB_READVERTISE_READVERTISE_POLICY_HPP
A policy to decide whether to readvertise a route, and what prefix to readvertise.
virtual std::optional< ReadvertiseAction > handleNewRoute(const RibRouteRef &ribRoute) const =0
Decide whether to readvertise a route, and what prefix to readvertise.
virtual time::milliseconds getRefreshInterval() const =0
virtual ~ReadvertisePolicy()=default
A decision made by readvertise policy.
Name prefix
the prefix that should be readvertised
ndn::security::SigningInfo signer
credentials for command signing
References a route.
Definition: rib.hpp:47