NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
forwarder-status-manager.cpp
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 
27 #include "fw/forwarder.hpp"
28 #include "core/version.hpp"
29 
30 namespace nfd {
31 
33  : m_forwarder(forwarder)
34  , m_dispatcher(dispatcher)
35  , m_startTimestamp(time::system_clock::now())
36 {
37  m_dispatcher.addStatusDataset("status/general", ndn::mgmt::makeAcceptAllAuthorization(),
38  std::bind(&ForwarderStatusManager::listGeneralStatus, this, _1, _2, _3));
39 }
40 
42 ForwarderStatusManager::collectGeneralStatus()
43 {
45 
46  status.setNfdVersion(NFD_VERSION_BUILD_STRING);
47  status.setStartTimestamp(m_startTimestamp);
49 
50  status.setNNameTreeEntries(m_forwarder.getNameTree().size());
51  status.setNFibEntries(m_forwarder.getFib().size());
52  status.setNPitEntries(m_forwarder.getPit().size());
53  status.setNMeasurementsEntries(m_forwarder.getMeasurements().size());
54  status.setNCsEntries(m_forwarder.getCs().size());
55 
56  const auto& counters = m_forwarder.getCounters();
57  status.setNInInterests(counters.nInInterests)
58  .setNOutInterests(counters.nOutInterests)
59  .setNInData(counters.nInData)
60  .setNOutData(counters.nOutData)
61  .setNInNacks(counters.nInNacks)
62  .setNOutNacks(counters.nOutNacks)
63  .setNSatisfiedInterests(counters.nSatisfiedInterests)
64  .setNUnsatisfiedInterests(counters.nUnsatisfiedInterests);
65 
66  return status;
67 }
68 
69 void
70 ForwarderStatusManager::listGeneralStatus(const Name&, const Interest&,
72 {
73  auto status = this->collectGeneralStatus();
74  const auto& wire = status.wireEncode();
75  wire.parse();
76  for (const auto& subblock : wire.elements()) {
77  context.append(subblock);
78  }
79  context.end();
80 }
81 
82 } // namespace nfd
ForwarderStatus & setNFibEntries(uint64_t nFibEntries)
const ForwarderCounters & getCounters() const
Definition: forwarder.hpp:63
represents NFD General Status dataset
ForwarderStatus & setNOutNacks(uint64_t nOutNacks)
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:130
Fib & getFib()
Definition: forwarder.hpp:88
ForwarderStatus & setNInData(uint64_t nInData)
ForwarderStatus & setNOutData(uint64_t nOutData)
ForwarderStatus & setNInNacks(uint64_t nInNacks)
Main class of NFD&#39;s forwarding engine.
Definition: forwarder.hpp:53
Represents an Interest packet.
Definition: interest.hpp:48
static time_point now() noexcept
Definition: time.cpp:46
Authorization makeAcceptAllAuthorization()
return an Authorization that accepts all Interests, with empty string as requester ...
Definition: dispatcher.cpp:32
ForwarderStatus & setNSatisfiedInterests(uint64_t nSatisfiedInterests)
size_t size() const
get number of stored packets
Definition: cs.hpp:94
ForwarderStatus & setNInInterests(uint64_t nInInterests)
ForwarderStatus & setStartTimestamp(const time::system_clock::TimePoint &startTimestamp)
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
void end()
Finalizes the response successfully after appending zero or more blocks.
ForwarderStatus & setNfdVersion(const std::string &nfdVersion)
ForwarderStatus & setNOutInterests(uint64_t nOutInterests)
ForwarderStatus & setNUnsatisfiedInterests(uint64_t nUnsatisfiedInterests)
ForwarderStatus & setNMeasurementsEntries(uint64_t nMeasurementsEntries)
Represents an absolute name.
Definition: name.hpp:41
void append(span< const uint8_t > bytes)
Appends a sequence of bytes to the response.
size_t size() const
Definition: pit.hpp:56
ForwarderStatus & setNPitEntries(uint64_t nPitEntries)
ForwarderStatus & setNCsEntries(uint64_t nCsEntries)
Measurements & getMeasurements()
Definition: forwarder.hpp:106
Pit & getPit()
Definition: forwarder.hpp:94
size_t size() const
Definition: name-tree.hpp:59
void addStatusDataset(const PartialName &relPrefix, Authorization authorize, StatusDatasetHandler handle)
register a StatusDataset or a prefix under which StatusDatasets can be requested
Definition: dispatcher.cpp:223
size_t size() const
Definition: fib.hpp:54
Provides a context for generating the response to a StatusDataset request.
ForwarderStatus & setNNameTreeEntries(uint64_t nNameTreeEntries)
ForwarderStatus & setCurrentTimestamp(const time::system_clock::TimePoint &currentTimestamp)
NameTree & getNameTree()
Definition: forwarder.hpp:82
ForwarderStatusManager(Forwarder &forwarder, Dispatcher &dispatcher)