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-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 
27 #include "fw/forwarder.hpp"
28 #include "core/version.hpp"
29 
30 namespace nfd {
31 
32 static const time::milliseconds STATUS_FRESHNESS(5000);
33 
35  : m_forwarder(forwarder)
36  , m_dispatcher(dispatcher)
37  , m_startTimestamp(time::system_clock::now())
38 {
39  m_dispatcher.addStatusDataset("status/general", ndn::mgmt::makeAcceptAllAuthorization(),
40  bind(&ForwarderStatusManager::listGeneralStatus, this, _1, _2, _3));
41 }
42 
44 ForwarderStatusManager::collectGeneralStatus()
45 {
47 
48  status.setNfdVersion(NFD_VERSION_BUILD_STRING);
49  status.setStartTimestamp(m_startTimestamp);
51 
52  status.setNNameTreeEntries(m_forwarder.getNameTree().size());
53  status.setNFibEntries(m_forwarder.getFib().size());
54  status.setNPitEntries(m_forwarder.getPit().size());
55  status.setNMeasurementsEntries(m_forwarder.getMeasurements().size());
56  status.setNCsEntries(m_forwarder.getCs().size());
57 
58  const ForwarderCounters& counters = m_forwarder.getCounters();
59  status.setNInInterests(counters.nInInterests)
61  .setNInData(counters.nInData)
62  .setNOutData(counters.nOutData)
63  .setNInNacks(counters.nInNacks)
64  .setNOutNacks(counters.nOutNacks)
67 
68  return status;
69 }
70 
71 void
72 ForwarderStatusManager::listGeneralStatus(const Name& topPrefix, const Interest& interest,
74 {
75  context.setExpiry(STATUS_FRESHNESS);
76 
77  auto status = this->collectGeneralStatus();
78  const Block& wire = status.wireEncode();
79  wire.parse();
80  for (const auto& subblock : wire.elements()) {
81  context.append(subblock);
82  }
83  context.end();
84 }
85 
86 } // namespace nfd
ForwarderStatus & setNFibEntries(uint64_t nFibEntries)
const ForwarderCounters & getCounters() const
Definition: forwarder.hpp:63
represents NFD General Status dataset
StatusDatasetContext & setExpiry(const time::milliseconds &expiry)
set expiration duration
size_t wireEncode(EncodingImpl< TAG > &encoder) const
prepend ForwarderStatus as a Content block to the encoder
static const time::milliseconds STATUS_FRESHNESS(5000)
counters provided by Forwarder
ForwarderStatus & setNOutNacks(uint64_t nOutNacks)
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:130
Fib & getFib()
Definition: forwarder.hpp:146
ForwarderStatus & setNInData(uint64_t nInData)
ForwarderStatus & setNOutData(uint64_t nOutData)
ForwarderStatus & setNInNacks(uint64_t nInNacks)
main class of NFD
Definition: forwarder.hpp:54
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:34
ForwarderStatus & setNSatisfiedInterests(uint64_t nSatisfiedInterests)
size_t size() const
get number of stored packets
Definition: cs.hpp:88
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:40
void end()
end 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)
size_t size() const
Definition: pit.hpp:56
ForwarderStatus & setNPitEntries(uint64_t nPitEntries)
ForwarderStatus & setNCsEntries(uint64_t nCsEntries)
Measurements & getMeasurements()
Definition: forwarder.hpp:164
Pit & getPit()
Definition: forwarder.hpp:152
void append(const Block &block)
append a Block to the response
size_t size() const
Definition: name-tree.hpp:61
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:56
provides a context for generating response to a StatusDataset request
ForwarderStatus & setNNameTreeEntries(uint64_t nNameTreeEntries)
ForwarderStatus & setCurrentTimestamp(const time::system_clock::TimePoint &currentTimestamp)
NameTree & getNameTree()
Definition: forwarder.hpp:140
ForwarderStatusManager(Forwarder &forwarder, Dispatcher &dispatcher)
PacketCounter nUnsatisfiedInterests