Loading...
Searching...
No Matches
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-2023, 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 "network-predicate.hpp"
31#include "udp-channel.hpp"
32
33namespace nfd::face {
34
38class UdpFactory final : public ProtocolFactory
39{
40public:
42 {
43 public:
44 using ProtocolFactory::Error::Error;
45 };
46
47 static const std::string&
48 getId() noexcept;
49
50 explicit
51 UdpFactory(const CtorParams& params);
52
68 shared_ptr<UdpChannel>
69 createChannel(const udp::Endpoint& localEndpoint,
70 time::nanoseconds idleTimeout);
71
94 shared_ptr<Face>
95 createMulticastFace(const ndn::net::NetworkInterface& netif,
96 const boost::asio::ip::address& localAddress,
97 const udp::Endpoint& multicastEndpoint);
98
99private:
100 void
101 doProcessConfig(OptionalConfigSection configSection,
102 FaceSystem::ConfigContext& context) final;
103
104 void
105 doCreateFace(const CreateFaceRequest& req,
106 const FaceCreatedCallback& onCreated,
107 const FaceCreationFailedCallback& onFailure) final;
108
109 std::vector<shared_ptr<const Channel>>
110 doGetChannels() const final;
111
116 std::vector<shared_ptr<Face>>
117 applyMcastConfigToNetif(const shared_ptr<const ndn::net::NetworkInterface>& netif);
118
122 void
123 applyMcastConfig(const FaceSystem::ConfigContext& context);
124
125private:
126 bool m_wantCongestionMarking = false;
127 size_t m_defaultUnicastMtu = ndn::MAX_NDN_PACKET_SIZE;
128 std::map<udp::Endpoint, shared_ptr<UdpChannel>> m_channels;
129
130 struct MulticastConfig
131 {
132 bool isEnabled = false;
135 ndn::nfd::LinkType linkType = ndn::nfd::LINK_TYPE_MULTI_ACCESS;
136 NetworkInterfacePredicate netifPredicate;
137 };
138 MulticastConfig m_mcastConfig;
139 std::map<udp::Endpoint, shared_ptr<Face>> m_mcastFaces;
140
141 signal::ScopedConnection m_netifAddConn;
142 struct NetifConns
143 {
144 signal::ScopedConnection addrAddConn;
145 };
146 std::map<int, NetifConns> m_netifConns; // ifindex => signal connections
147};
148
149} // namespace nfd::face
150
151#endif // NFD_DAEMON_FACE_UDP_FACTORY_HPP
Represents a channel that listens on a local endpoint.
Definition channel.hpp:43
Generalization of a network interface.
Definition face.hpp:118
Entry point of NFD's face system.
Represents a predicate to accept or reject a ndn::net::NetworkInterface.
Base class for all exceptions thrown by ProtocolFactory subclasses.
Provides support for an underlying protocol.
Class implementing a UDP-based channel to create faces.
Protocol factory for UDP over IPv4 and IPv6.
shared_ptr< Face > createMulticastFace(const ndn::net::NetworkInterface &netif, const boost::asio::ip::address &localAddress, const udp::Endpoint &multicastEndpoint)
Create a multicast UDP face.
static const std::string & getId() noexcept
shared_ptr< UdpChannel > createChannel(const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
Create UDP-based channel using udp::Endpoint.
Definition main.cpp:34
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:94
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:90
Endpoint getDefaultMulticastGroup()
Returns the default IPv4 multicast group: 224.0.23.170:56363
Endpoint getDefaultMulticastGroupV6()
Returns the default IPv6 multicast group: [FF02::1234]:56363
boost::asio::ip::udp::endpoint Endpoint
boost::optional< const ConfigSection & > OptionalConfigSection
An optional configuration file section.
Encapsulates a face creation request and all its parameters.
Parameters to ProtocolFactory constructor.