NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2019, 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 {
32 namespace face {
33 
34 class FaceSystem;
35 
38 class NetdevBound : noncopyable
39 {
40 public:
42  {
43  public:
44  RuleParseError(int index, std::string msg)
45  : Error("Error parsing face_system.netdev_bound.rule[" + to_string(index) + "]: " + msg)
46  , index(index)
47  , msg(std::move(msg))
48  {
49  }
50 
51  public:
52  int index;
53  std::string msg;
54  };
55 
56  NetdevBound(const ProtocolFactoryCtorParams& params, const FaceSystem& faceSystem);
57 
60  void
62  FaceSystem::ConfigContext& context);
63 
65  struct Rule
66  {
67  std::vector<FaceUri> remotes;
68  NetworkInterfacePredicate netifPredicate;
69  };
70 
71  Rule
72  parseRule(int index, const ConfigSection& confRule) const;
73 
75  const FaceSystem& m_faceSystem;
76  FaceCreatedCallback m_addFace;
77  shared_ptr<ndn::net::NetworkMonitor> m_netmon;
78 
79  std::vector<Rule> m_rules;
80 
81  using Key = std::pair<FaceUri, std::string>;
82  std::map<Key, shared_ptr<Face>> m_faces;
83 };
84 
85 } // namespace face
86 } // namespace nfd
87 
88 #endif // NFD_DAEMON_FACE_NETDEV_BOUND_HPP
PUBLIC_WITH_TESTS_ELSE_PRIVATE
#define PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
protocol-factory.hpp
nfd::face::NetdevBound
manages netdev-bound faces
Definition: netdev-bound.hpp:39
nonstd::optional_lite::std11::move
T & move(T &t)
Definition: optional.hpp:421
nfd::face::NetdevBound::RuleParseError::RuleParseError
RuleParseError(int index, std::string msg)
Definition: netdev-bound.hpp:44
nfd::face::NetdevBound::RuleParseError::index
int index
Definition: netdev-bound.hpp:52
nfd::face::FaceSystem
entry point of the face system
Definition: face-system.hpp:52
Rule
ndn security validator_config Rule
Definition: rule.cpp:27
nfd::face::NetworkInterfacePredicate
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
Definition: network-predicate.hpp:98
nfd::OptionalConfigSection
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
nfd::face::FaceSystem
FaceSystem
Definition: face-system.cpp:35
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::NetdevBound::NetdevBound
NetdevBound(const ProtocolFactoryCtorParams &params, const FaceSystem &faceSystem)
Definition: netdev-bound.cpp:35
nfd::face::NetdevBound::RuleParseError
Definition: netdev-bound.hpp:42
nfd::face::ProtocolFactoryCtorParams
Parameters to ProtocolFactory constructor.
Definition: protocol-factory.hpp:47
nfd::ConfigSection
boost::property_tree::ptree ConfigSection
a config file section
Definition: ndn-l3-protocol.hpp:39
nfd::ConfigFile::Error
Definition: config-file.hpp:61
nfd::face::NetdevBound::processConfig
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
process face_system.netdev_bound config section
Definition: netdev-bound.cpp:43
nfd::face::FaceCreatedCallback
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:74
ndn::to_string
std::string to_string(const T &val)
Definition: backports.hpp:102
nfd::face::NetdevBound::RuleParseError::msg
std::string msg
Definition: netdev-bound.hpp:53
nfd::face::FaceSystem::ConfigContext
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:97