NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd-rib-readvertise-destination.hpp
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 
26 #ifndef NFD_DAEMON_RIB_READVERTISE_NFD_RIB_READVERTISE_DESTINATION_HPP
27 #define NFD_DAEMON_RIB_READVERTISE_NFD_RIB_READVERTISE_DESTINATION_HPP
28 
30 #include "rib/rib.hpp"
31 
35 
36 namespace nfd {
37 namespace rib {
38 
42 {
43 public:
45  Rib& rib,
47  const ndn::nfd::ControlParameters& parameters =
49  .setOrigin(ndn::nfd::ROUTE_ORIGIN_CLIENT));
50 
53  void
54  advertise(const ReadvertisedRoute& rr,
55  std::function<void()> successCb,
56  std::function<void(const std::string&)> failureCb) override;
57 
60  void
61  withdraw(const ReadvertisedRoute& rr,
62  std::function<void()> successCb,
63  std::function<void(const std::string&)> failureCb) override;
64 
65 protected:
68 
71 
72 private:
73  void
74  handleRibInsert(const Name& name);
75 
76  void
77  handleRibErase(const Name& name);
78 
79 private:
80  ndn::nfd::Controller& m_controller;
81 
82  signal::ScopedConnection m_ribInsertConn;
83  signal::ScopedConnection m_ribEraseConn;
84 
85  ndn::nfd::CommandOptions m_commandOptions;
86  ndn::nfd::ControlParameters m_controlParameters;
87 };
88 
89 } // namespace rib
90 } // namespace nfd
91 
92 #endif // NFD_DAEMON_RIB_READVERTISE_NFD_RIB_READVERTISE_DESTINATION_HPP
nfd::rib::ReadvertisedRoute
state of a readvertised route
Definition: readvertised-route.hpp:40
ndn::util::signal::ScopedConnection
Disconnects a Connection automatically upon destruction.
Definition: scoped-connection.hpp:34
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
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
nfd::rib::NfdRibReadvertiseDestination::getControlParameters
ndn::nfd::ControlParameters getControlParameters()
Definition: nfd-rib-readvertise-destination.cpp:82
controller.hpp
ndn::nfd::Controller
NFD Management protocol client.
Definition: controller.hpp:52
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
rib.hpp
readvertise-destination.hpp
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
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
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
nfd::rib::ReadvertiseDestination
a destination to readvertise into
Definition: readvertise-destination.hpp:37
ndn::nfd::ROUTE_ORIGIN_CLIENT
@ ROUTE_ORIGIN_CLIENT
Definition: nfd-constants.hpp:103
ndn::nfd::CommandOptions
contains options for ControlCommand execution
Definition: command-options.hpp:35
ndn::nfd::ControlParameters
represents parameters in a ControlCommand request or response
Definition: control-parameters.hpp:82
ndn::name
Definition: name-component-types.hpp:33
command-options.hpp
control-parameters.hpp
nfd::rib::NfdRibReadvertiseDestination::getCommandOptions
ndn::nfd::CommandOptions getCommandOptions()
Definition: nfd-rib-readvertise-destination.cpp:88