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 
47 using NextHopList = std::vector<NextHop>;
48 
51 class Entry : noncopyable
52 {
53 public:
54  explicit
55  Entry(const Name& prefix);
56 
57  const Name&
58  getPrefix() const
59  {
60  return m_prefix;
61  }
62 
63  const NextHopList&
64  getNextHops() const
65  {
66  return m_nextHops;
67  }
68 
71  bool
72  hasNextHops() const
73  {
74  return !m_nextHops.empty();
75  }
76 
79  bool
80  hasNextHop(const Face& face, uint64_t endpointId) const;
81 
87  void
88  addOrUpdateNextHop(Face& face, uint64_t endpointId, uint64_t cost);
89 
92  void
93  removeNextHop(const Face& face, uint64_t endpointId);
94 
97  void
98  removeNextHopByFace(const Face& face);
99 
100 private:
104  findNextHop(const Face& face, uint64_t endpointId);
105 
108  void
109  sortNextHops();
110 
111 private:
112  Name m_prefix;
113  NextHopList m_nextHops;
114 
115  name_tree::Entry* m_nameTreeEntry;
116 
117  friend class name_tree::Entry;
118 };
119 
120 } // namespace fib
121 } // namespace nfd
122 
123 #endif // NFD_DAEMON_TABLE_FIB_ENTRY_HPP
const Name & getPrefix() const
Definition: fib-entry.hpp:58
generalization of a network interface
Definition: face.hpp:67
represents a FIB entry
Definition: fib-entry.hpp:51
bool hasNextHop(const Face &face, uint64_t endpointId) const
Definition: fib-entry.cpp:47
Represents a collection of nexthops.
Entry(const Name &prefix)
Definition: fib-entry.cpp:31
Table::const_iterator iterator
Definition: cs-internal.hpp:41
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
void removeNextHop(const Face &face, uint64_t endpointId)
removes the NextHop record for face with the given endpointId
Definition: fib-entry.cpp:65
Represents an absolute name.
Definition: name.hpp:43
void addOrUpdateNextHop(Face &face, uint64_t endpointId, uint64_t cost)
adds a NextHop record
Definition: fib-entry.cpp:53
const NextHopList & getNextHops() const
Definition: fib-entry.hpp:64
void removeNextHopByFace(const Face &face)
removes all NextHop records on face for any endpointId
Definition: fib-entry.cpp:74
bool hasNextHops() const
Definition: fib-entry.hpp:72
an entry in the name tree