NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
udp-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_UDP_FACTORY_HPP
27 #define NFD_DAEMON_FACE_UDP_FACTORY_HPP
28 
29 #include "protocol-factory.hpp"
30 #include "udp-channel.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
37 class UdpFactory final : public ProtocolFactory
38 {
39 public:
41  {
42  public:
43  using ProtocolFactory::Error::Error;
44  };
45 
46  static const std::string&
47  getId() noexcept;
48 
49  explicit
50  UdpFactory(const CtorParams& params);
51 
67  shared_ptr<UdpChannel>
68  createChannel(const udp::Endpoint& localEndpoint,
69  time::nanoseconds idleTimeout);
70 
93  shared_ptr<Face>
94  createMulticastFace(const shared_ptr<const ndn::net::NetworkInterface>& netif,
95  const boost::asio::ip::address& localAddress,
96  const udp::Endpoint& multicastEndpoint);
97 
98 private:
101  void
102  doProcessConfig(OptionalConfigSection configSection,
103  FaceSystem::ConfigContext& context) final;
104 
105  void
106  doCreateFace(const CreateFaceRequest& req,
107  const FaceCreatedCallback& onCreated,
108  const FaceCreationFailedCallback& onFailure) final;
109 
110  std::vector<shared_ptr<const Channel>>
111  doGetChannels() const final;
112 
116  std::vector<shared_ptr<Face>>
117  applyMcastConfigToNetif(const shared_ptr<const ndn::net::NetworkInterface>& netif);
118 
121  void
122  applyMcastConfig(const FaceSystem::ConfigContext& context);
123 
124 private:
125  bool m_wantCongestionMarking = false;
126  size_t m_defaultUnicastMtu = ndn::MAX_NDN_PACKET_SIZE;
127  std::map<udp::Endpoint, shared_ptr<UdpChannel>> m_channels;
128 
129  struct MulticastConfig
130  {
131  bool isEnabled = false;
135  NetworkInterfacePredicate netifPredicate;
136  };
137  MulticastConfig m_mcastConfig;
138  std::map<udp::Endpoint, shared_ptr<Face>> m_mcastFaces;
139 
140  signal::ScopedConnection m_netifAddConn;
141  struct NetifConns
142  {
143  signal::ScopedConnection addrAddConn;
144  };
145  std::map<int, NetifConns> m_netifConns; // ifindex => signal connections
146 };
147 
148 } // namespace face
149 } // namespace nfd
150 
151 #endif // NFD_DAEMON_FACE_UDP_FACTORY_HPP
shared_ptr< Face > createMulticastFace(const shared_ptr< const ndn::net::NetworkInterface > &netif, const boost::asio::ip::address &localAddress, const udp::Endpoint &multicastEndpoint)
Create a multicast UDP face.
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
Protocol factory for UDP over IPv4 and IPv6.
Definition: udp-factory.hpp:37
Endpoint getDefaultMulticastGroup()
Provides support for an underlying protocol.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
Disconnects a Connection automatically upon destruction.
shared_ptr< UdpChannel > createChannel(const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
Create UDP-based channel using udp::Endpoint.
Parameters to ProtocolFactory constructor.
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
Base class for all exceptions thrown by ProtocolFactory subclasses.
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:96
boost::asio::ip::udp::endpoint Endpoint
static const std::string & getId() noexcept
Definition: udp-factory.cpp:44
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
Endpoint getDefaultMulticastGroupV6()
UdpFactory(const CtorParams &params)
Definition: udp-factory.cpp:50
boost::chrono::nanoseconds nanoseconds
Definition: time.hpp:50
const size_t MAX_NDN_PACKET_SIZE
Practical size limit of a network-layer packet.
Definition: tlv.hpp:41