NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
cs-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 
26 #include "cs-manager.hpp"
27 #include <ndn-cxx/mgmt/nfd/cs-info.hpp>
28 
29 namespace nfd {
30 
32  Dispatcher& dispatcher, CommandAuthenticator& authenticator)
33  : NfdManagerBase(dispatcher, authenticator, "cs")
34  , m_cs(cs)
35  , m_fwCnt(fwCnt)
36 {
37  registerCommandHandler<ndn::nfd::CsConfigCommand>("config",
38  bind(&CsManager::changeConfig, this, _4, _5));
39 
40  registerStatusDatasetHandler("info", bind(&CsManager::serveInfo, this, _1, _2, _3));
41 }
42 
43 void
44 CsManager::changeConfig(const ControlParameters& parameters,
46 {
47  using ndn::nfd::CsFlagBit;
48 
49  if (parameters.hasCapacity()) {
50  m_cs.setLimit(parameters.getCapacity());
51  }
52 
55  }
56 
59  }
60 
61  ControlParameters body;
62  body.setCapacity(m_cs.getLimit());
63  body.setFlagBit(CsFlagBit::BIT_CS_ENABLE_ADMIT, m_cs.shouldAdmit(), false);
64  body.setFlagBit(CsFlagBit::BIT_CS_ENABLE_SERVE, m_cs.shouldServe(), false);
65  done(ControlResponse(200, "OK").setBody(body.wireEncode()));
66 }
67 
68 void
69 CsManager::serveInfo(const Name& topPrefix, const Interest& interest,
70  ndn::mgmt::StatusDatasetContext& context) const
71 {
72  ndn::nfd::CsInfo info;
73  info.setCapacity(m_cs.getLimit());
74  info.setEnableAdmit(m_cs.shouldAdmit());
75  info.setEnableServe(m_cs.shouldServe());
76  info.setNEntries(m_cs.size());
77  info.setNHits(m_fwCnt.nCsHits);
78  info.setNMisses(m_fwCnt.nCsMisses);
79 
80  context.append(info.wireEncode());
81  context.end();
82 }
83 
84 } // namespace nfd
CsInfo & setNHits(uint64_t nHits)
Definition: cs-info.cpp:165
counters provided by Forwarder
represents parameters in a ControlCommand request or response
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:129
size_t getLimit() const
get capacity (in number of packets)
Definition: cs.hpp:100
CsManager(Cs &cs, const ForwarderCounters &fwCnt, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
Definition: cs-manager.cpp:31
bool shouldAdmit() const
get CS_ENABLE_ADMIT flag
Definition: cs.hpp:131
CsInfo & setNEntries(uint64_t nEntries)
Definition: cs-info.cpp:157
bool shouldServe() const
get CS_ENABLE_SERVE flag
Definition: cs.hpp:146
void enableAdmit(bool shouldAdmit)
set CS_ENABLE_ADMIT flag
Definition: cs.cpp:208
CsInfo & setEnableAdmit(bool enableAdmit)
Definition: cs-info.cpp:141
size_t size() const
get number of stored packets
Definition: cs.hpp:91
mgmt::ControlResponse ControlResponse
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
CsInfo & setEnableServe(bool enableServe)
Definition: cs-info.cpp:149
void end()
end the response successfully after appending zero or more blocks
enables the CS to satisfy Interests using cached Data
void setLimit(size_t nMaxPackets)
change capacity (in number of packets)
Definition: cs.hpp:108
enables the CS to admit new Data
represents the CS Information dataset
Definition: cs-info.hpp:37
bool hasFlagBit(size_t bit) const
std::function< void(const ControlResponse &resp)> CommandContinuation
a function to be called after ControlCommandHandler completes
Definition: dispatcher.hpp:95
represents the ContentStore
Definition: cs.hpp:62
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Definition: cs-info.cpp:48
CsInfo & setCapacity(uint64_t capacity)
Definition: cs-info.cpp:133
provides ControlCommand authorization according to NFD configuration file
void append(const Block &block)
append a Block to the response
bool getFlagBit(size_t bit) const
provides a context for generating response to a StatusDataset request
a collection of common functions shared by all NFD managers, such as communicating with the dispatche...
CsFlagBit
CS enablement flags.
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
CsInfo & setNMisses(uint64_t nMisses)
Definition: cs-info.cpp:173
void enableServe(bool shouldServe)
set CS_ENABLE_SERVE flag
Definition: cs.cpp:218