NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
fib-entry.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_TABLE_FIB_ENTRY_HPP
27 #define NFD_DAEMON_TABLE_FIB_ENTRY_HPP
28 
29 #include "fib-nexthop.hpp"
30 
31 namespace nfd {
32 
33 namespace name_tree {
34 class Entry;
35 } // namespace name_tree
36 
37 namespace fib {
38 
39 class Fib;
40 
49 using NextHopList = std::vector<NextHop>;
50 
53 class Entry : noncopyable
54 {
55 public:
56  explicit
57  Entry(const Name& prefix);
58 
59  const Name&
60  getPrefix() const
61  {
62  return m_prefix;
63  }
64 
65  const NextHopList&
66  getNextHops() const
67  {
68  return m_nextHops;
69  }
70 
73  bool
74  hasNextHops() const
75  {
76  return !m_nextHops.empty();
77  }
78 
81  bool
82  hasNextHop(const Face& face) const;
83 
84 private:
92  std::pair<NextHopList::iterator, bool>
93  addOrUpdateNextHop(Face& face, uint64_t cost);
94 
99  bool
100  removeNextHop(const Face& face);
101 
104  NextHopList::iterator
105  findNextHop(const Face& face);
106 
109  void
110  sortNextHops();
111 
112 private:
113  Name m_prefix;
114  NextHopList m_nextHops;
115 
116  name_tree::Entry* m_nameTreeEntry = nullptr;
117 
118  friend class name_tree::Entry;
119  friend class Fib;
120 };
121 
122 } // namespace fib
123 } // namespace nfd
124 
125 #endif // NFD_DAEMON_TABLE_FIB_ENTRY_HPP
nfd::name_tree::Entry
An entry in the name tree.
Definition: name-tree-entry.hpp:42
nfd::fib::Entry::Entry
Entry(const Name &prefix)
Definition: fib-entry.cpp:31
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::Face
generalization of a network interface
Definition: face.hpp:53
nfd::fib::Entry::getNextHops
const NextHopList & getNextHops() const
Definition: fib-entry.hpp:66
nfd::fib::NextHopList
std::vector< NextHop > NextHopList
Definition: fib-entry.hpp:49
nfd::fib::Entry
represents a FIB entry
Definition: fib-entry.hpp:54
nfd::fib::Entry::hasNextHop
bool hasNextHop(const Face &face) const
Definition: fib-entry.cpp:46
nfd::fib::Fib
Represents the Forwarding Information Base (FIB)
Definition: fib.hpp:48
fib-nexthop.hpp
nfd::fib::Entry::getPrefix
const Name & getPrefix() const
Definition: fib-entry.hpp:60
nfd::fib::Entry::hasNextHops
bool hasNextHops() const
Definition: fib-entry.hpp:74