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-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_FW_PIT_ALGORITHM_HPP
27 #define NFD_DAEMON_FW_PIT_ALGORITHM_HPP
28 
29 #include "fw/scope-prefix.hpp"
30 #include "table/fib.hpp"
31 #include "table/pit-entry.hpp"
32 
37 namespace nfd {
38 namespace fw {
39 
43 bool
44 wouldViolateScope(const Face& inFace, const Interest& interest, const Face& outFace);
45 
56 bool
57 canForwardToLegacy(const pit::Entry& pitEntry, const Face& face);
58 
67 };
68 
72 int
73 findDuplicateNonce(const pit::Entry& pitEntry, uint32_t nonce, const Face& face);
74 
78 bool
79 hasPendingOutRecords(const pit::Entry& pitEntry);
80 
84 time::steady_clock::TimePoint
85 getLastOutgoing(const pit::Entry& pitEntry);
86 
90 fib::NextHopList::const_iterator
91 findEligibleNextHopWithEarliestOutRecord(const Face& inFace, const Interest& interest,
92  const fib::NextHopList& nexthops,
93  const shared_ptr<pit::Entry>& pitEntry);
94 
103 bool
104 isNextHopEligible(const Face& inFace, const Interest& interest,
105  const fib::NextHop& nexthop,
106  const shared_ptr<pit::Entry>& pitEntry,
107  bool wantUnused = false,
108  time::steady_clock::TimePoint now = time::steady_clock::TimePoint::min());
109 
110 } // namespace fw
111 } // namespace nfd
112 
113 #endif // NFD_DAEMON_FW_PIT_ALGORITHM_HPP
bool canForwardToLegacy(const pit::Entry &pitEntry, const Face &face)
decide whether Interest can be forwarded to face
Definition: algorithm.cpp:54
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:132
in-record of same face
Definition: algorithm.hpp:63
An Interest table entry.
Definition: pit-entry.hpp:58
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
bool isNextHopEligible(const Face &inFace, const Interest &interest, const fib::NextHop &nexthop, const shared_ptr< pit::Entry > &pitEntry, bool wantUnused, time::steady_clock::TimePoint now)
determines whether a NextHop is eligible i.e.
Definition: algorithm.cpp:154
Represents a collection of nexthops.
Definition: fib-entry.hpp:39
bool hasPendingOutRecords(const pit::Entry &pitEntry)
determine whether pitEntry has any pending out-records
Definition: algorithm.cpp:108
no duplicate Nonce is found
Definition: algorithm.hpp:62
time::steady_clock::TimePoint getLastOutgoing(const pit::Entry &pitEntry)
Definition: algorithm.cpp:119
int findDuplicateNonce(const pit::Entry &pitEntry, uint32_t nonce, const Face &face)
determine whether pitEntry has duplicate Nonce nonce
Definition: algorithm.cpp:78
in-record of other face
Definition: algorithm.hpp:64
DuplicateNonceWhere
indicates where duplicate Nonces are found
Definition: algorithm.hpp:61
out-record of other face
Definition: algorithm.hpp:66
Represents a nexthop record in a FIB entry.
Definition: fib-nexthop.hpp:37
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:32
out-record of same face
Definition: algorithm.hpp:65