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-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_FACE_NETDEV_BOUND_HPP
27 #define NFD_DAEMON_FACE_NETDEV_BOUND_HPP
28 
29 #include "protocol-factory.hpp"
30 
31 namespace nfd::face {
32 
33 class FaceSystem;
34 
37 class NetdevBound : noncopyable
38 {
39 public:
41  {
42  public:
43  RuleParseError(int index, std::string msg)
44  : Error("Error parsing face_system.netdev_bound.rule[" + to_string(index) + "]: " + msg)
45  , index(index)
46  , msg(std::move(msg))
47  {
48  }
49 
50  public:
51  int index;
52  std::string msg;
53  };
54 
55  NetdevBound(const ProtocolFactoryCtorParams& params, const FaceSystem& faceSystem);
56 
59  void
61  FaceSystem::ConfigContext& context);
62 
64  struct Rule
65  {
66  std::vector<FaceUri> remotes;
67  NetworkInterfacePredicate netifPredicate;
68  };
69 
70  Rule
71  parseRule(int index, const ConfigSection& confRule) const;
72 
74  const FaceSystem& m_faceSystem;
75  FaceCreatedCallback m_addFace;
76  shared_ptr<ndn::net::NetworkMonitor> m_netmon;
77 
78  std::vector<Rule> m_rules;
79 
80  using Key = std::pair<FaceUri, std::string>;
81  std::map<Key, shared_ptr<Face>> m_faces;
82 };
83 
84 } // namespace nfd::face
85 
86 #endif // NFD_DAEMON_FACE_NETDEV_BOUND_HPP
Context for processing a config section in ProtocolFactory.
Definition: face-system.hpp:99
Entry point of NFD's face system.
Definition: face-system.hpp:53
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:88
boost::optional< const ConfigSection & > OptionalConfigSection
An optional configuration file section.
Definition: config-file.hpp:43
boost::property_tree::ptree ConfigSection
A configuration file section.
Definition: config-file.hpp:38
Parameters to ProtocolFactory constructor.