netdev-bound.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2024, 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_FACE_NETDEV_BOUND_HPP
27 #define NFD_DAEMON_FACE_NETDEV_BOUND_HPP
28 
29 #include "network-predicate.hpp"
30 #include "protocol-factory.hpp"
31 
32 namespace nfd::face {
33 
34 class FaceSystem;
35 
39 class NetdevBound : noncopyable
40 {
41 public:
43  {
44  public:
45  RuleParseError(int index, std::string msg)
46  : Error("Error parsing face_system.netdev_bound.rule[" + std::to_string(index) + "]: " + msg)
47  , index(index)
48  , msg(std::move(msg))
49  {
50  }
51 
52  public:
53  int index;
54  std::string msg;
55  };
56 
57  NetdevBound(const ProtocolFactoryCtorParams& params, const FaceSystem& faceSystem);
58 
61  void
63  FaceSystem::ConfigContext& context);
64 
66  struct Rule
67  {
68  std::vector<FaceUri> remotes;
69  NetworkInterfacePredicate netifPredicate;
70  };
71 
72  Rule
73  parseRule(int index, const ConfigSection& confRule) const;
74 
76  const FaceSystem& m_faceSystem;
77  FaceCreatedCallback m_addFace;
78  shared_ptr<ndn::net::NetworkMonitor> m_netmon;
79 
80  std::vector<Rule> m_rules;
81 
82  using Key = std::pair<FaceUri, std::string>;
83  std::map<Key, shared_ptr<Face>> m_faces;
84 };
85 
86 } // namespace nfd::face
87 
88 #endif // NFD_DAEMON_FACE_NETDEV_BOUND_HPP
Context for processing a config section in ProtocolFactory.
Entry point of NFD's face system.
Definition: face-system.hpp:55
RuleParseError(int index, std::string msg)
Manages netdev-bound faces.
NetdevBound(const ProtocolFactoryCtorParams &params, const FaceSystem &faceSystem)
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
Process face_system.netdev_bound config section.
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
#define NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
std::function< void(const shared_ptr< Face > &)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:90
boost::optional< const ConfigSection & > OptionalConfigSection
An optional configuration file section.
Definition: config-file.hpp:46
boost::property_tree::ptree ConfigSection
A configuration file section.
Definition: config-file.hpp:41
Parameters to ProtocolFactory constructor.