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-2017, 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 CreateFaceParams& params,
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 
120  shared_ptr<Face>
121  createMulticastFace(const udp::Endpoint& localEndpoint,
122  const udp::Endpoint& multicastEndpoint,
123  const std::string& networkInterfaceName = "");
124 
125  shared_ptr<Face>
126  createMulticastFace(const std::string& localIp,
127  const std::string& multicastIp,
128  const std::string& multicastPort,
129  const std::string& networkInterfaceName = "");
130 
131 private:
135  shared_ptr<Face>
136  applyMcastConfigToNetif(const shared_ptr<const ndn::net::NetworkInterface>& netif);
137 
140  void
141  applyMcastConfig(const FaceSystem::ConfigContext& context);
142 
143 private:
144  std::map<udp::Endpoint, shared_ptr<UdpChannel>> m_channels;
145 
146  struct MulticastConfig
147  {
148  bool isEnabled = false;
150  ndn::nfd::LinkType linkType = ndn::nfd::LINK_TYPE_MULTI_ACCESS;
151  NetworkInterfacePredicate netifPredicate;
152  };
153 
154  MulticastConfig m_mcastConfig;
155  std::map<udp::Endpoint, shared_ptr<Face>> m_mcastFaces;
156 
157  signal::ScopedConnection m_netifAddConn;
158  struct NetifConns
159  {
160  signal::ScopedConnection addrAddConn;
161  };
162  std::map<int, NetifConns> m_netifConns; // ifindex => signal connections
163 };
164 
165 } // namespace face
166 } // namespace nfd
167 
168 #endif // NFD_DAEMON_FACE_UDP_FACTORY_HPP
void createFace(const CreateFaceParams &params, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
Try to create face using the supplied parameters.
UdpFactory(const CtorParams &params)
Definition: udp-factory.cpp:56
std::vector< shared_ptr< const Channel > > getChannels() const override
Error(const std::string &what)
Definition: udp-factory.hpp:50
shared_ptr< UdpChannel > createChannel(const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
Create UDP-based channel using udp::Endpoint.
Exception of UdpFactory.
Definition: udp-factory.hpp:46
Endpoint getDefaultMulticastGroup()
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:85
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
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
boost::asio::ip::udp::endpoint Endpoint
Provides support for an underlying protocol.
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
process face_system.udp config section
Definition: udp-factory.cpp:63
Parameters to ProtocolFactory constructor.
static const std::string & getId()
Definition: udp-factory.cpp:50
Parameters to ProtocolFactory::createFace.
Represents a predicate to accept or reject a NetworkInterfaceInfo.
protocol factory for UDP over IPv4 and IPv6
Definition: udp-factory.hpp:40
Base class for all exceptions thrown by ProtocolFactory subclasses.
shared_ptr< Face > createMulticastFace(const udp::Endpoint &localEndpoint, const udp::Endpoint &multicastEndpoint, const std::string &networkInterfaceName="")
Create multicast UDP face using udp::Endpoint.
function< void(const shared_ptr< Face > &newFace)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:35