All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
multicast-discovery.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2025, 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 #include "multicast-discovery.hpp"
27 
28 #include <boost/lexical_cast.hpp>
29 
30 #include <ndn-cxx/encoding/tlv-nfd.hpp>
31 #include <ndn-cxx/mgmt/nfd/control-command.hpp>
32 #include <ndn-cxx/mgmt/nfd/status-dataset.hpp>
33 
34 namespace ndn::autoconfig {
35 
36 using nfd::ControlParameters;
37 
38 const Name HUB_DISCOVERY_PREFIX{"/localhop/ndn-autoconf/hub"};
39 constexpr uint64_t HUB_DISCOVERY_ROUTE_COST = 1;
40 constexpr time::milliseconds HUB_DISCOVERY_ROUTE_EXPIRATION = 30_s;
41 constexpr time::milliseconds HUB_DISCOVERY_INTEREST_LIFETIME = 4_s;
42 
43 MulticastDiscovery::MulticastDiscovery(Face& face, nfd::Controller& controller)
44  : m_face(face)
45  , m_controller(controller)
46 {
47 }
48 
49 void
50 MulticastDiscovery::doStart()
51 {
52  nfd::FaceQueryFilter filter;
53  filter.setLinkType(nfd::LINK_TYPE_MULTI_ACCESS);
54 
55  m_controller.fetch<nfd::FaceQueryDataset>(
56  filter,
57  [this] (const auto& dataset) { registerHubDiscoveryPrefix(dataset); },
58  [this] (uint32_t code, const std::string& reason) {
59  fail("Error " + std::to_string(code) + " when querying multi-access faces: " + reason);
60  });
61 }
62 
63 void
64 MulticastDiscovery::registerHubDiscoveryPrefix(const std::vector<nfd::FaceStatus>& dataset)
65 {
66  if (dataset.empty()) {
67  fail("No multi-access faces available");
68  return;
69  }
70 
71  m_nRegs = dataset.size();
72  m_nRegSuccess = 0;
73  m_nRegFailure = 0;
74 
75  for (const auto& faceStatus : dataset) {
76  ControlParameters parameters;
77  parameters.setName(HUB_DISCOVERY_PREFIX)
78  .setFaceId(faceStatus.getFaceId())
79  .setCost(HUB_DISCOVERY_ROUTE_COST)
80  .setExpirationPeriod(HUB_DISCOVERY_ROUTE_EXPIRATION);
81 
82  m_controller.start<nfd::RibRegisterCommand>(
83  parameters,
84  [this] (const auto&) {
85  ++m_nRegSuccess;
86  afterReg();
87  },
88  [this, faceStatus] (const auto& resp) {
89  std::cerr << "Error " << resp.getCode() << " when registering hub discovery prefix "
90  << "for face " << faceStatus.getFaceId() << " (" << faceStatus.getRemoteUri()
91  << "): " << resp.getText() << std::endl;
92  ++m_nRegFailure;
93  afterReg();
94  });
95  }
96 }
97 
98 void
99 MulticastDiscovery::afterReg()
100 {
101  if (m_nRegSuccess + m_nRegFailure < m_nRegs) {
102  return; // continue waiting
103  }
104  if (m_nRegSuccess > 0) {
105  setStrategy();
106  }
107  else {
108  fail("Cannot register hub discovery prefix for any face");
109  }
110 }
111 
112 void
113 MulticastDiscovery::setStrategy()
114 {
115  ControlParameters parameters;
116  parameters.setName(HUB_DISCOVERY_PREFIX)
117  .setStrategy("/localhost/nfd/strategy/multicast");
118 
119  m_controller.start<nfd::StrategyChoiceSetCommand>(
120  parameters,
121  [this] (const auto&) { requestHubData(); },
122  [this] (const auto& resp) {
123  fail("Error " + std::to_string(resp.getCode()) + " when setting multicast strategy: " + resp.getText());
124  });
125 }
126 
127 void
128 MulticastDiscovery::requestHubData()
129 {
130  Interest interest(HUB_DISCOVERY_PREFIX);
131  interest.setCanBePrefix(true);
132  interest.setMustBeFresh(true);
133  interest.setInterestLifetime(HUB_DISCOVERY_INTEREST_LIFETIME);
134 
135  m_face.expressInterest(interest,
136  [this] (const Interest&, const Data& data) {
137  const Block& content = data.getContent();
138  content.parse();
139 
140  auto i = content.find(tlv::nfd::Uri);
141  if (i == content.elements_end()) {
142  fail("Malformed hub Data: missing Uri element");
143  return;
144  }
145 
146  provideHubFaceUri(std::string(reinterpret_cast<const char*>(i->value()), i->value_size()));
147  },
148  [this] (const Interest&, const lp::Nack& nack) {
149  fail("Nack-" + boost::lexical_cast<std::string>(nack.getReason()) + " when retrieving hub Data");
150  },
151  [this] (const Interest&) {
152  fail("Timeout when retrieving hub Data");
153  });
154 }
155 
156 } // namespace ndn::autoconfig
MulticastDiscovery(Face &face, nfd::Controller &controller)
void provideHubFaceUri(const std::string &s)
Parse HUB FaceUri from string and declare success.
Definition: stage.cpp:43
void fail(const std::string &msg)
Definition: stage.cpp:63
constexpr uint64_t HUB_DISCOVERY_ROUTE_COST
const Name HUB_DISCOVERY_PREFIX
constexpr time::milliseconds HUB_DISCOVERY_INTEREST_LIFETIME
constexpr time::milliseconds HUB_DISCOVERY_ROUTE_EXPIRATION