NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ethernet-factory.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2021, 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_ETHERNET_FACTORY_HPP
27 #define NFD_DAEMON_FACE_ETHERNET_FACTORY_HPP
28 
29 #include "protocol-factory.hpp"
30 #include "ethernet-channel.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
37 class EthernetFactory final : public ProtocolFactory
38 {
39 public:
40  static const std::string&
41  getId() noexcept;
42 
43  explicit
44  EthernetFactory(const CtorParams& params);
45 
56  shared_ptr<EthernetChannel>
57  createChannel(const shared_ptr<const ndn::net::NetworkInterface>& localEndpoint,
58  time::nanoseconds idleTimeout);
59 
71  shared_ptr<Face>
73  const ethernet::Address& group);
74 
75 private:
78  void
79  doProcessConfig(OptionalConfigSection configSection,
80  FaceSystem::ConfigContext& context) final;
81 
82  void
83  doCreateFace(const CreateFaceRequest& req,
84  const FaceCreatedCallback& onCreated,
85  const FaceCreationFailedCallback& onFailure) final;
86 
87  std::vector<shared_ptr<const Channel>>
88  doGetChannels() const final;
89 
93  shared_ptr<EthernetChannel>
94  applyUnicastConfigToNetif(const shared_ptr<const ndn::net::NetworkInterface>& netif);
95 
99  shared_ptr<Face>
100  applyMcastConfigToNetif(const ndn::net::NetworkInterface& netif);
101 
102  void
103  applyConfig(const FaceSystem::ConfigContext& context);
104 
105 private:
106  std::map<std::string, shared_ptr<EthernetChannel>> m_channels;
107 
108  struct UnicastConfig
109  {
110  bool isEnabled = false;
111  bool wantListen = false;
112  time::nanoseconds idleTimeout = 10_min;
113  };
114  UnicastConfig m_unicastConfig;
115 
116  struct MulticastConfig
117  {
118  bool isEnabled = false;
121  NetworkInterfacePredicate netifPredicate;
122  };
123  MulticastConfig m_mcastConfig;
124 
126  std::map<std::pair<std::string, ethernet::Address>, shared_ptr<Face>> m_mcastFaces;
127 
128  signal::ScopedConnection m_netifAddConn;
129 };
130 
131 } // namespace face
132 } // namespace nfd
133 
134 #endif // NFD_DAEMON_FACE_ETHERNET_FACTORY_HPP
std::function< void(uint32_t status, const std::string &reason)> FaceCreationFailedCallback
Prototype for the callback that is invoked when a face fails to be created.
Definition: channel.hpp:90
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
Represents one network interface attached to the host.
Provides support for an underlying protocol.
Address getDefaultMulticastAddress()
Returns the default Ethernet multicast address for NDN.
Definition: ethernet.cpp:121
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
EthernetFactory(const CtorParams &params)
Disconnects a Connection automatically upon destruction.
Protocol factory for Ethernet.
Parameters to ProtocolFactory constructor.
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
shared_ptr< Face > createMulticastFace(const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &group)
Create a face to communicate on the given Ethernet multicast group.
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:96
represents an Ethernet hardware address
Definition: ethernet.hpp:52
Encapsulates a face creation request and all its parameters.
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:86
static const std::string & getId() noexcept
boost::chrono::nanoseconds nanoseconds
Definition: time.hpp:50
shared_ptr< EthernetChannel > createChannel(const shared_ptr< const ndn::net::NetworkInterface > &localEndpoint, time::nanoseconds idleTimeout)
Create Ethernet-based channel on the specified network interface.