NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-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_FIB_UPDATE_HPP
27 #define NFD_DAEMON_RIB_FIB_UPDATE_HPP
28 
29 #include "core/common.hpp"
30 
31 namespace nfd {
32 namespace rib {
33 
37 class FibUpdate
38 {
39 public:
41  : faceId(0)
42  , cost(0)
43  {
44  }
45 
46  bool
47  operator==(const FibUpdate& other) const
48  {
49  return (this->name == other.name &&
50  this->faceId == other.faceId &&
51  this->cost == other.cost &&
52  this->action == other.action);
53  }
54 
55  static FibUpdate
56  createAddUpdate(const Name& name, const uint64_t faceId, const uint64_t cost);
57 
58  static FibUpdate
59  createRemoveUpdate(const Name& name, const uint64_t faceId);
60 
61  enum Action {
63  REMOVE_NEXTHOP = 1
64  };
65 
66 public:
68  uint64_t faceId;
69  uint64_t cost;
71 };
72 
73 inline std::ostream&
74 operator<<(std::ostream& os, const FibUpdate& update)
75 {
76  os << "FibUpdate("
77  << " Name: " << update.name << ", "
78  << "faceId: " << update.faceId << ", ";
79 
80  if (update.action == FibUpdate::ADD_NEXTHOP) {
81  os << "cost: " << update.cost << ", "
82  << "action: ADD_NEXTHOP";
83  }
84  else {
85  os << "action: REMOVE_NEXTHOP";
86  }
87 
88  os << ")";
89 
90  return os;
91 }
92 
93 } // namespace rib
94 } // namespace nfd
95 
96 #endif // NFD_DAEMON_RIB_FIB_UPDATE_HPP
nfd::rib::FibUpdate::operator==
bool operator==(const FibUpdate &other) const
Definition: fib-update.hpp:47
nfd::rib::FibUpdate::createAddUpdate
static FibUpdate createAddUpdate(const Name &name, const uint64_t faceId, const uint64_t cost)
Definition: fib-update.cpp:32
nfd::rib::FibUpdate::REMOVE_NEXTHOP
@ REMOVE_NEXTHOP
Definition: fib-update.hpp:63
nfd::rib::FibUpdate::faceId
uint64_t faceId
Definition: fib-update.hpp:68
nfd::rib::FibUpdate::name
Name name
Definition: fib-update.hpp:67
nfd::rib::FibUpdate::createRemoveUpdate
static FibUpdate createRemoveUpdate(const Name &name, const uint64_t faceId)
Definition: fib-update.cpp:45
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
common.hpp
nfd::rib::FibUpdate::action
Action action
Definition: fib-update.hpp:70
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::rib::FibUpdate::cost
uint64_t cost
Definition: fib-update.hpp:69
nfd::rib::FibUpdate::Action
Action
Definition: fib-update.hpp:61
nfd::rib::operator<<
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
Definition: fib-update.hpp:74
nfd::rib::FibUpdate
represents a FIB update
Definition: fib-update.hpp:38
ndn::name
Definition: name-component-types.hpp:33
nfd::rib::FibUpdate::FibUpdate
FibUpdate()
Definition: fib-update.hpp:40
nfd::rib::FibUpdate::ADD_NEXTHOP
@ ADD_NEXTHOP
Definition: fib-update.hpp:62