fib-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_FIB_UPDATE_HPP
27 #define NFD_DAEMON_RIB_FIB_UPDATE_HPP
28 
29 #include "core/common.hpp"
30 
31 namespace nfd::rib {
32 
36 class FibUpdate
37 {
38 public:
40  : faceId(0)
41  , cost(0)
42  {
43  }
44 
45  bool
46  operator==(const FibUpdate& other) const
47  {
48  return (this->name == other.name &&
49  this->faceId == other.faceId &&
50  this->cost == other.cost &&
51  this->action == other.action);
52  }
53 
54  static FibUpdate
55  createAddUpdate(const Name& name, const uint64_t faceId, const uint64_t cost);
56 
57  static FibUpdate
58  createRemoveUpdate(const Name& name, const uint64_t faceId);
59 
60  enum Action {
62  REMOVE_NEXTHOP = 1
63  };
64 
65 public:
66  Name name;
67  uint64_t faceId;
68  uint64_t cost;
70 };
71 
72 inline std::ostream&
73 operator<<(std::ostream& os, const FibUpdate& update)
74 {
75  os << "FibUpdate("
76  << " Name: " << update.name << ", "
77  << "faceId: " << update.faceId << ", ";
78 
79  if (update.action == FibUpdate::ADD_NEXTHOP) {
80  os << "cost: " << update.cost << ", "
81  << "action: ADD_NEXTHOP";
82  }
83  else {
84  os << "action: REMOVE_NEXTHOP";
85  }
86 
87  os << ")";
88 
89  return os;
90 }
91 
92 } // namespace nfd::rib
93 
94 #endif // NFD_DAEMON_RIB_FIB_UPDATE_HPP
represents a FIB update
Definition: fib-update.hpp:37
static FibUpdate createRemoveUpdate(const Name &name, const uint64_t faceId)
Definition: fib-update.cpp:44
static FibUpdate createAddUpdate(const Name &name, const uint64_t faceId, const uint64_t cost)
Definition: fib-update.cpp:31
bool operator==(const FibUpdate &other) const
Definition: fib-update.hpp:46
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
Definition: fib-update.hpp:73