NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
rib-update.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_RIB_UPDATE_HPP
27 #define NFD_DAEMON_RIB_RIB_UPDATE_HPP
28 
29 #include "core/common.hpp"
30 #include "route.hpp"
31 
32 namespace nfd {
33 namespace rib {
34 
40 class RibUpdate
41 {
42 public:
43  enum Action {
44  REGISTER = 0,
46 
51  REMOVE_FACE = 2
52  };
53 
54  RibUpdate();
55 
56  RibUpdate&
57  setAction(Action action);
58 
59  Action
60  getAction() const;
61 
62  RibUpdate&
63  setName(const Name& name);
64 
65  const Name&
66  getName() const;
67 
68  RibUpdate&
69  setRoute(const Route& route);
70 
71  const Route&
72  getRoute() const;
73 
74 private:
75  Action m_action;
76  Name m_name;
77  Route m_route;
78 };
79 
80 inline RibUpdate&
82 {
83  m_action = action;
84  return *this;
85 }
86 
87 inline RibUpdate::Action
89 {
90  return m_action;
91 }
92 
93 inline RibUpdate&
95 {
96  m_name = name;
97  return *this;
98 }
99 
100 inline const Name&
102 {
103  return m_name;
104 }
105 
106 inline RibUpdate&
108 {
109  m_route = route;
110  return *this;
111 }
112 
113 inline const Route&
115 {
116  return m_route;
117 }
118 
119 std::ostream&
120 operator<<(std::ostream& os, const RibUpdate::Action action);
121 
122 std::ostream&
123 operator<<(std::ostream& os, const RibUpdate& update);
124 
125 } // namespace rib
126 } // namespace nfd
127 
128 #endif // NFD_DAEMON_RIB_RIB_UPDATE_HPP
nfd::rib::RibUpdate::setAction
RibUpdate & setAction(Action action)
Definition: rib-update.hpp:81
nfd::rib::RibUpdate::setRoute
RibUpdate & setRoute(const Route &route)
Definition: rib-update.hpp:107
nfd::rib::RibUpdate::setName
RibUpdate & setName(const Name &name)
Definition: rib-update.hpp:94
nfd::rib::RibUpdate::UNREGISTER
@ UNREGISTER
Definition: rib-update.hpp:45
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
route.hpp
common.hpp
nfd::rib::RibUpdate
RibUpdate.
Definition: rib-update.hpp:41
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::rib::RibUpdate::Action
Action
Definition: rib-update.hpp:43
nfd::rib::operator<<
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
Definition: fib-update.hpp:74
nfd::rib::RibUpdate::RibUpdate
RibUpdate()
Definition: rib-update.cpp:31
nfd::rib::RibUpdate::getRoute
const Route & getRoute() const
Definition: rib-update.hpp:114
nfd::rib::RibUpdate::REGISTER
@ REGISTER
Definition: rib-update.hpp:44
nfd::rib::RibUpdate::getAction
Action getAction() const
Definition: rib-update.hpp:88
nfd::rib::RibUpdate::REMOVE_FACE
@ REMOVE_FACE
An update triggered by a face destruction notification.
Definition: rib-update.hpp:51
ndn::name
Definition: name-component-types.hpp:33
nfd::rib::Route
represents a route for a name prefix
Definition: route.hpp:44
nfd::rib::RibUpdate::getName
const Name & getName() const
Definition: rib-update.hpp:101