NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
algorithm.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2021, 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_FW_ALGORITHM_HPP
27 #define NFD_DAEMON_FW_ALGORITHM_HPP
28 
29 #include "table/fib-entry.hpp"
30 #include "table/pit-entry.hpp"
31 
36 namespace nfd {
37 namespace fw {
38 
42 bool
43 wouldViolateScope(const Face& inFace, const Interest& interest, const Face& outFace);
44 
53 };
54 
58 int
59 findDuplicateNonce(const pit::Entry& pitEntry, Interest::Nonce nonce, const Face& face);
60 
64 bool
65 hasPendingOutRecords(const pit::Entry& pitEntry);
66 
71 getLastOutgoing(const pit::Entry& pitEntry);
72 
76 fib::NextHopList::const_iterator
77 findEligibleNextHopWithEarliestOutRecord(const Face& inFace, const Interest& interest,
78  const fib::NextHopList& nexthops,
79  const shared_ptr<pit::Entry>& pitEntry);
80 
89 bool
90 isNextHopEligible(const Face& inFace, const Interest& interest,
91  const fib::NextHop& nexthop,
92  const shared_ptr<pit::Entry>& pitEntry,
93  bool wantUnused = false,
94  time::steady_clock::TimePoint now = time::steady_clock::TimePoint::min());
95 
96 } // namespace fw
97 } // namespace nfd
98 
99 #endif // NFD_DAEMON_FW_ALGORITHM_HPP
fib::NextHopList::const_iterator findEligibleNextHopWithEarliestOutRecord(const Face &inFace, const Interest &interest, const fib::NextHopList &nexthops, const shared_ptr< pit::Entry > &pitEntry)
pick an eligible NextHop with earliest out-record
Definition: algorithm.cpp:109
Represents an Interest packet.
Definition: interest.hpp:48
Represents a collection of nexthops.
Definition: fib-entry.hpp:39
int findDuplicateNonce(const pit::Entry &pitEntry, Interest::Nonce nonce, const Face &face)
determine whether pitEntry has duplicate Nonce nonce
Definition: algorithm.cpp:55
in-record of same face
Definition: algorithm.hpp:49
ndn Face
Definition: face-impl.hpp:42
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
An Interest table entry.
Definition: pit-entry.hpp:58
bool hasPendingOutRecords(const pit::Entry &pitEntry)
determine whether pitEntry has any pending out-records
Definition: algorithm.cpp:85
no duplicate Nonce is found
Definition: algorithm.hpp:48
time::steady_clock::time_point getLastOutgoing(const pit::Entry &pitEntry)
Definition: algorithm.cpp:96
bool isNextHopEligible(const Face &inFace, const Interest &interest, const fib::NextHop &nexthop, const shared_ptr< pit::Entry > &pitEntry, bool wantUnused, time::steady_clock::time_point now)
Definition: algorithm.cpp:131
in-record of other face
Definition: algorithm.hpp:50
DuplicateNonceWhere
indicates where duplicate Nonces are found
Definition: algorithm.hpp:47
out-record of other face
Definition: algorithm.hpp:52
bool wouldViolateScope(const Face &inFace, const Interest &interest, const Face &outFace)
determine whether forwarding the Interest in pitEntry to outFace would violate scope ...
Definition: algorithm.cpp:33
time_point TimePoint
Definition: time.hpp:233
Represents a nexthop record in a FIB entry.
Definition: fib-nexthop.hpp:37
out-record of same face
Definition: algorithm.hpp:51