name-prefix-table.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2025,  The University of Memphis,
 *                           Regents of the University of California,
 *                           Arizona Board of Regents.
 *
 * This file is part of NLSR (Named-data Link State Routing).
 * See AUTHORS.md for complete list of NLSR authors and contributors.
 *
 * NLSR is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NLSR, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NLSR_NAME_PREFIX_TABLE_HPP
#define NLSR_NAME_PREFIX_TABLE_HPP
 
#include "name-prefix-table-entry.hpp"
#include "routing-table-pool-entry.hpp"
#include "signals.hpp"
#include "test-access-control.hpp"
#include "route/fib.hpp"
#include "lsdb.hpp"
 
#include <list>
#include <unordered_map>
 
namespace nlsr {
 
class NamePrefixTable
{
public:
  using RoutingTableEntryPool =
    std::unordered_map<ndn::Name, std::shared_ptr<RoutingTablePoolEntry>>;
  using NptEntryList = std::list<std::shared_ptr<NamePrefixTableEntry>>;
  using const_iterator = NptEntryList::const_iterator;
  using DestNameKey = std::tuple<ndn::Name, ndn::Name>;
 
  NamePrefixTable(const ndn::Name& ownRouterName, Fib& fib, RoutingTable& routingTable,
                  AfterRoutingChange& afterRoutingChangeSignal,
                  Lsdb::AfterLsdbModified& afterLsdbModifiedSignal);
 
  ~NamePrefixTable();
 
  NexthopList
  adjustNexthopCosts(const NexthopList& nhlist, const ndn::Name& nameToCheck, const ndn::Name& destRouterName);
 
  void
  updateFromLsdb(std::shared_ptr<Lsa> lsa, LsdbUpdate updateType,
                 const std::list<nlsr::PrefixInfo>& namesToAdd,
                 const std::list<nlsr::PrefixInfo>& namesToRemove);
 
  void
  addEntry(const ndn::Name& name, const ndn::Name& destRouter, uint64_t routeFlags = ndn::nfd::ROUTE_FLAG_CAPTURE);
 
  void
  removeEntry(const ndn::Name& name, const ndn::Name& destRouter);
 
  void
  updateWithNewRoute(const std::list<RoutingTableEntry>& entries);
 
  std::shared_ptr<RoutingTablePoolEntry>
  addRtpeToPool(RoutingTablePoolEntry& rtpe);
 
  void
  deleteRtpeFromPool(std::shared_ptr<RoutingTablePoolEntry> rtpePtr);
 
  void
  writeLog();
 
  const_iterator
  begin() const;
 
  const_iterator
  end() const;
 
PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  RoutingTableEntryPool m_rtpool;
 
  NptEntryList m_table;
 
private:
  const ndn::Name& m_ownRouterName;
  Fib& m_fib;
  RoutingTable& m_routingTable;
  ndn::signal::Connection m_afterRoutingChangeConnection;
  ndn::signal::Connection m_afterLsdbModified;
  std::map<std::tuple<ndn::Name, ndn::Name>, double> m_nexthopCost;
};
 
inline NamePrefixTable::const_iterator
NamePrefixTable::begin() const
{
  return m_table.begin();
}
 
inline NamePrefixTable::const_iterator
NamePrefixTable::end() const
{
  return m_table.end();
}
 
std::ostream&
operator<<(std::ostream& os, const NamePrefixTable& table);
 
} // namespace nlsr
 
#endif // NLSR_NAME_PREFIX_TABLE_HPP