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-2018, 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  RuleParseError(int index, std::string msg, const char* innerMsg)
52  : RuleParseError(index, msg + " - " + innerMsg)
53  {
54  }
55 
56  public:
57  int index;
58  std::string msg;
59  };
60 
61  NetdevBound(const ProtocolFactoryCtorParams& params, const FaceSystem& faceSystem);
62 
65  void
67  FaceSystem::ConfigContext& context);
68 
70  struct Rule
71  {
72  std::vector<FaceUri> remotes;
73  NetworkInterfacePredicate netifPredicate;
74  };
75 
76  Rule
77  parseRule(int index, const ConfigSection& confRule) const;
78 
80  const FaceSystem& m_faceSystem;
81  FaceCreatedCallback m_addFace;
82  shared_ptr<ndn::net::NetworkMonitor> m_netmon;
83 
84  std::vector<Rule> m_rules;
85 
86  using Key = std::pair<FaceUri, std::string>;
87  std::map<Key, shared_ptr<Face>> m_faces;
88 };
89 
90 } // namespace face
91 } // namespace nfd
92 
93 #endif // NFD_DAEMON_FACE_NETDEV_BOUND_HPP
#define PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:40
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
process face_system.netdev_bound config section
RuleParseError(int index, std::string msg, const char *innerMsg)
entry point of the face system
Definition: face-system.hpp:51
ndn security validator_config Rule
Definition: rule.cpp:27
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
std::function< void(const shared_ptr< Face > &face)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:40
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
Error(const std::string &what)
Definition: config-file.hpp:64
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
manages netdev-bound faces
Parameters to ProtocolFactory constructor.
boost::property_tree::ptree ConfigSection
a config file section
NetdevBound(const ProtocolFactoryCtorParams &params, const FaceSystem &faceSystem)
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:96
std::string to_string(const V &v)
Definition: backports.hpp:67
RuleParseError(int index, std::string msg)