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-2022, 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::rib {
33 
38 class RibUpdate
39 {
40 public:
41  enum Action {
42  REGISTER = 0,
49  };
50 
51  RibUpdate&
52  setAction(Action action);
53 
54  Action
55  getAction() const;
56 
57  RibUpdate&
58  setName(const Name& name);
59 
60  const Name&
61  getName() const;
62 
63  RibUpdate&
64  setRoute(const Route& route);
65 
66  const Route&
67  getRoute() const;
68 
69 private:
70  Action m_action;
71  Name m_name;
72  Route m_route;
73 };
74 
75 inline RibUpdate&
77 {
78  m_action = action;
79  return *this;
80 }
81 
82 inline RibUpdate::Action
84 {
85  return m_action;
86 }
87 
88 inline RibUpdate&
89 RibUpdate::setName(const Name& name)
90 {
91  m_name = name;
92  return *this;
93 }
94 
95 inline const Name&
97 {
98  return m_name;
99 }
100 
101 inline RibUpdate&
103 {
104  m_route = route;
105  return *this;
106 }
107 
108 inline const Route&
110 {
111  return m_route;
112 }
113 
114 std::ostream&
115 operator<<(std::ostream& os, RibUpdate::Action action);
116 
117 std::ostream&
118 operator<<(std::ostream& os, const RibUpdate& update);
119 
120 } // namespace nfd::rib
121 
122 #endif // NFD_DAEMON_RIB_RIB_UPDATE_HPP
Represents a route that will be added to or removed from a namespace.
Definition: rib-update.hpp:39
const Name & getName() const
Definition: rib-update.hpp:96
const Route & getRoute() const
Definition: rib-update.hpp:109
RibUpdate & setAction(Action action)
Definition: rib-update.hpp:76
@ REMOVE_FACE
An update triggered by a face destruction notification.
Definition: rib-update.hpp:48
Action getAction() const
Definition: rib-update.hpp:83
RibUpdate & setName(const Name &name)
Definition: rib-update.hpp:89
RibUpdate & setRoute(const Route &route)
Definition: rib-update.hpp:102
Represents a route for a name prefix.
Definition: route.hpp:44
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
Definition: fib-update.cpp:52