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-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_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 
41 {
42 public:
47  {
48  public:
49  explicit
50  Error(const std::string& what)
51  : ProtocolFactory::Error(what)
52  {
53  }
54  };
55 
56  static const std::string&
57  getId();
58 
59  explicit
60  UdpFactory(const CtorParams& params);
61 
64  void
66  FaceSystem::ConfigContext& context) override;
67 
68  void
69  createFace(const CreateFaceRequest& req,
70  const FaceCreatedCallback& onCreated,
71  const FaceCreationFailedCallback& onFailure) override;
72 
88  shared_ptr<UdpChannel>
89  createChannel(const udp::Endpoint& localEndpoint,
90  time::nanoseconds idleTimeout);
91 
92  std::vector<shared_ptr<const Channel>>
93  getChannels() const override;
94 
117  shared_ptr<Face>
118  createMulticastFace(const shared_ptr<const ndn::net::NetworkInterface>& netif,
119  const boost::asio::ip::address& localAddress,
120  const udp::Endpoint& multicastEndpoint);
121 
122 private:
126  std::vector<shared_ptr<Face>>
127  applyMcastConfigToNetif(const shared_ptr<const ndn::net::NetworkInterface>& netif);
128 
131  void
132  applyMcastConfig(const FaceSystem::ConfigContext& context);
133 
134 private:
135  bool m_wantCongestionMarking = false;
136  std::map<udp::Endpoint, shared_ptr<UdpChannel>> m_channels;
137 
138  struct MulticastConfig
139  {
140  bool isEnabled = false;
144  NetworkInterfacePredicate netifPredicate;
145  };
146  MulticastConfig m_mcastConfig;
147  std::map<udp::Endpoint, shared_ptr<Face>> m_mcastFaces;
148 
149  signal::ScopedConnection m_netifAddConn;
150  struct NetifConns
151  {
152  signal::ScopedConnection addrAddConn;
153  };
154  std::map<int, NetifConns> m_netifConns; // ifindex => signal connections
155 };
156 
157 } // namespace face
158 } // namespace nfd
159 
160 #endif // NFD_DAEMON_FACE_UDP_FACTORY_HPP
void createFace(const CreateFaceRequest &req, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
Try to create a unicast face using the supplied parameters.
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.
ProtocolFactoryCtorParams CtorParams
Error(const std::string &what)
Definition: udp-factory.hpp:50
std::vector< shared_ptr< const Channel > > getChannels() const override
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
Exception of UdpFactory.
Definition: udp-factory.hpp:46
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:44
static const std::string & getId()
Definition: udp-factory.cpp:45
protocol factory for UDP over IPv4 and IPv6
Definition: udp-factory.hpp:40
Endpoint getDefaultMulticastGroup()
Represents a predicate to accept or reject a NetworkInterfaceInfo.
Provides support for an underlying protocol.
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
process face_system.udp config section
Definition: udp-factory.cpp:58
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
disconnects a Connection automatically upon destruction
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
shared_ptr< UdpChannel > createChannel(const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
Create UDP-based channel using udp::Endpoint.
Base class for all exceptions thrown by ProtocolFactory subclasses.
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:92
boost::asio::ip::udp::endpoint Endpoint
Endpoint getDefaultMulticastGroupV6()
UdpFactory(const CtorParams &params)
Definition: udp-factory.cpp:51