NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd-rib-readvertise-destination.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2019, 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 "common/logger.hpp"
28 
31 
32 namespace nfd {
33 namespace rib {
34 
36 
38 
40  Rib& rib,
41  const ndn::nfd::CommandOptions& options,
42  const ndn::nfd::ControlParameters& parameters)
43  : m_controller(controller)
44  , m_commandOptions(options)
45  , m_controlParameters(parameters)
46 {
47  m_ribInsertConn = rib.afterInsertEntry.connect(
48  std::bind(&NfdRibReadvertiseDestination::handleRibInsert, this, _1));
49  m_ribEraseConn = rib.afterEraseEntry.connect(
50  std::bind(&NfdRibReadvertiseDestination::handleRibErase, this, _1));
51 }
52 
53 void
55  std::function<void()> successCb,
56  std::function<void(const std::string&)> failureCb)
57 {
58  NFD_LOG_DEBUG("advertise " << rr.prefix << " on " << m_commandOptions.getPrefix());
59 
60  m_controller.start<ndn::nfd::RibRegisterCommand>(
62  [=] (const ControlParameters& cp) { successCb(); },
63  [=] (const ControlResponse& cr) { failureCb(cr.getText()); },
65 }
66 
67 void
69  std::function<void()> successCb,
70  std::function<void(const std::string&)> failureCb)
71 {
72  NFD_LOG_DEBUG("withdraw " << rr.prefix << " on " << m_commandOptions.getPrefix());
73 
76  [=] (const ControlParameters& cp) { successCb(); },
77  [=] (const ControlResponse& cr) { failureCb(cr.getText()); },
79 }
80 
83 {
84  return m_controlParameters;
85 }
86 
89 {
90  return m_commandOptions;
91 }
92 
93 void
94 NfdRibReadvertiseDestination::handleRibInsert(const ndn::Name& name)
95 {
96  if (name.isPrefixOf(m_commandOptions.getPrefix())) {
97  setAvailability(true);
98  }
99 }
100 
101 void
102 NfdRibReadvertiseDestination::handleRibErase(const ndn::Name& name)
103 {
104  if (name.isPrefixOf(m_commandOptions.getPrefix())) {
105  setAvailability(false);
106  }
107 }
108 
109 } // namespace rib
110 } // namespace nfd
nfd::rib::ReadvertisedRoute
state of a readvertised route
Definition: readvertised-route.hpp:40
nfd-rib-readvertise-destination.hpp
ndn::nfd::RibRegisterCommand
represents a rib/register command
Definition: control-command.hpp:297
nfd::rib::NfdRibReadvertiseDestination::NfdRibReadvertiseDestination
NfdRibReadvertiseDestination(ndn::nfd::Controller &controller, Rib &rib, const ndn::nfd::CommandOptions &options=ndn::nfd::CommandOptions(), const ndn::nfd::ControlParameters &parameters=ndn::nfd::ControlParameters() .setOrigin(ndn::nfd::ROUTE_ORIGIN_CLIENT))
Definition: nfd-rib-readvertise-destination.cpp:39
control-command.hpp
nfd::rib::NfdRibReadvertiseDestination::advertise
void advertise(const ReadvertisedRoute &rr, std::function< void()> successCb, std::function< void(const std::string &)> failureCb) override
add a name prefix into NFD RIB
Definition: nfd-rib-readvertise-destination.cpp:54
ndn::nfd::ControlResponse
mgmt::ControlResponse ControlResponse
Definition: control-response.hpp:30
nfd::rib::NfdRibReadvertiseDestination::getControlParameters
ndn::nfd::ControlParameters getControlParameters()
Definition: nfd-rib-readvertise-destination.cpp:82
ndn::nfd::Controller
NFD Management protocol client.
Definition: controller.hpp:52
nfd::rib::Rib::afterInsertEntry
signal::Signal< Rib, Name > afterInsertEntry
signals after a RIB entry is inserted
Definition: rib.hpp:217
nfd::rib::ReadvertisedRoute::signer
ndn::security::SigningInfo signer
signer for commands
Definition: readvertised-route.hpp:52
ndn::nfd::CommandOptions::getPrefix
const Name & getPrefix() const
Definition: command-options.hpp:63
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::rib::Rib::afterEraseEntry
signal::Signal< Rib, Name > afterEraseEntry
signals after a RIB entry is erased
Definition: rib.hpp:224
nfd::rib::ReadvertiseDestination::setAvailability
void setAvailability(bool isAvailable)
Definition: readvertise-destination.cpp:35
nfd::rib::NfdRibReadvertiseDestination
a readvertise destination using NFD RIB management protocol
Definition: nfd-rib-readvertise-destination.hpp:42
nfd::rib::Rib
represents the Routing Information Base
Definition: rib.hpp:60
control-response.hpp
nfd::rib::NfdRibReadvertiseDestination::withdraw
void withdraw(const ReadvertisedRoute &rr, std::function< void()> successCb, std::function< void(const std::string &)> failureCb) override
remove a name prefix from NFD RIB
Definition: nfd-rib-readvertise-destination.cpp:68
ndn::nfd::CommandOptions::setSigningInfo
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
sets signing parameters
Definition: command-options.cpp:55
ndn::nfd::RibUnregisterCommand
represents a rib/unregister command
Definition: control-command.hpp:315
ndn::nfd::Controller::start
void start(const ControlParameters &parameters, const CommandSucceedCallback &onSuccess, const CommandFailCallback &onFailure, const CommandOptions &options=CommandOptions())
start command execution
Definition: controller.hpp:78
nfd::rib::ReadvertisedRoute::prefix
Name prefix
readvertised prefix
Definition: readvertised-route.hpp:51
ndn::mgmt::ControlResponse
ControlCommand response.
Definition: control-response.hpp:33
ndn::nfd::CommandOptions
contains options for ControlCommand execution
Definition: command-options.hpp:35
ndn::nfd::ControlParameters::setName
ControlParameters & setName(const Name &name)
Definition: control-parameters.hpp:120
NFD_LOG_DEBUG
#define NFD_LOG_DEBUG
Definition: logger.hpp:38
ndn::nfd::ControlParameters
represents parameters in a ControlCommand request or response
Definition: control-parameters.hpp:82
ndn::name
Definition: name-component-types.hpp:33
nfd::rib::NfdRibReadvertiseDestination::getCommandOptions
ndn::nfd::CommandOptions getCommandOptions()
Definition: nfd-rib-readvertise-destination.cpp:88
NFD_LOG_INIT
#define NFD_LOG_INIT(name)
Definition: logger.hpp:31
logger.hpp