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-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_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::fw {
37 
41 bool
42 wouldViolateScope(const Face& inFace, const Interest& interest, const Face& outFace);
43 
52 };
53 
57 int
58 findDuplicateNonce(const pit::Entry& pitEntry, Interest::Nonce nonce, const Face& face);
59 
63 bool
64 hasPendingOutRecords(const pit::Entry& pitEntry);
65 
69 time::steady_clock::time_point
70 getLastOutgoing(const pit::Entry& pitEntry);
71 
75 fib::NextHopList::const_iterator
76 findEligibleNextHopWithEarliestOutRecord(const Face& inFace, const Interest& interest,
77  const fib::NextHopList& nexthops,
78  const shared_ptr<pit::Entry>& pitEntry);
79 
88 bool
89 isNextHopEligible(const Face& inFace, const Interest& interest,
90  const fib::NextHop& nexthop,
91  const shared_ptr<pit::Entry>& pitEntry,
92  bool wantUnused = false,
93  time::steady_clock::time_point now = time::steady_clock::time_point::min());
94 
95 } // namespace nfd::fw
96 
97 #endif // NFD_DAEMON_FW_ALGORITHM_HPP
Generalization of a network interface.
Definition: face.hpp:118
Represents a nexthop record in a FIB entry.
Definition: fib-entry.hpp:50
Represents an entry in the Interest table (PIT).
Definition: pit-entry.hpp:197
std::vector< NextHop > NextHopList
A collection of nexthops in a FIB entry.
Definition: fib-entry.hpp:84
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)
Determines whether a NextHop is eligible, i.e., not the same inFace.
Definition: algorithm.cpp:131
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
DuplicateNonceWhere
Indicates where duplicate Nonces are found.
Definition: algorithm.hpp:46
@ DUPLICATE_NONCE_OUT_SAME
out-record of same face
Definition: algorithm.hpp:50
@ DUPLICATE_NONCE_NONE
no duplicate Nonce is found
Definition: algorithm.hpp:47
@ DUPLICATE_NONCE_IN_SAME
in-record of same face
Definition: algorithm.hpp:48
@ DUPLICATE_NONCE_OUT_OTHER
out-record of other face
Definition: algorithm.hpp:51
@ DUPLICATE_NONCE_IN_OTHER
in-record of other face
Definition: algorithm.hpp:49
int findDuplicateNonce(const pit::Entry &pitEntry, Interest::Nonce nonce, const Face &face)
Determine whether pitEntry has duplicate Nonce nonce.
Definition: algorithm.cpp:55
bool hasPendingOutRecords(const pit::Entry &pitEntry)
Determine whether pitEntry has any pending out-records.
Definition: algorithm.cpp:85
time::steady_clock::time_point getLastOutgoing(const pit::Entry &pitEntry)
Definition: algorithm.cpp:96
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