rib-entry.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2025,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD 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.
 *
 * NFD 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
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NFD_DAEMON_RIB_RIB_ENTRY_HPP
#define NFD_DAEMON_RIB_RIB_ENTRY_HPP
 
#include "route.hpp"
 
#include <list>
 
namespace nfd::rib {
 
class RibEntry : public std::enable_shared_from_this<RibEntry>
{
public:
  using RouteList = std::list<Route>;
  using iterator = RouteList::iterator;
  using const_iterator = RouteList::const_iterator;
 
  const Name&
  getName() const noexcept
  {
    return m_name;
  }
 
  void
  setName(const Name& prefix)
  {
    m_name = prefix;
  }
 
  shared_ptr<RibEntry>
  getParent() const
  {
    return m_parent;
  }
 
  const std::list<shared_ptr<RibEntry>>&
  getChildren() const noexcept
  {
    return m_children;
  }
 
  void
  addChild(shared_ptr<RibEntry> child);
 
  void
  removeChild(shared_ptr<RibEntry> child);
 
  std::pair<RibEntry::iterator, bool>
  insertRoute(const Route& route);
 
  void
  eraseRoute(const Route& route);
 
  iterator
  eraseRoute(RouteList::iterator route);
 
  bool
  hasFaceId(uint64_t faceId) const;
 
  iterator
  findRoute(const Route& route);
 
  const_iterator
  findRoute(const Route& route) const;
 
  void
  addInheritedRoute(const Route& route);
 
  void
  removeInheritedRoute(const Route& route);
 
  const RouteList&
  getInheritedRoutes() const noexcept
  {
    return m_inheritedRoutes;
  }
 
  RouteList::const_iterator
  findInheritedRoute(const Route& route) const;
 
  bool
  hasInheritedRoute(const Route& route) const;
 
  bool
  hasCapture() const noexcept
  {
    return m_nRoutesWithCaptureSet > 0;
  }
 
  bool
  hasChildInheritOnFaceId(uint64_t faceId) const;
 
  const Route*
  getRouteWithLowestCostByFaceId(uint64_t faceId) const;
 
  const Route*
  getRouteWithSecondLowestCostByFaceId(uint64_t faceId) const;
 
  const Route*
  getRouteWithLowestCostAndChildInheritByFaceId(uint64_t faceId) const;
 
  ndn::PrefixAnnouncement
  getPrefixAnnouncement(time::milliseconds minExpiration = 15_s,
                        time::milliseconds maxExpiration = 1_h) const;
 
  const RouteList&
  getRoutes() const noexcept
  {
    return m_routes;
  }
 
  bool
  empty() const noexcept
  {
    return m_routes.empty();
  }
 
  const_iterator
  begin() const noexcept
  {
    return m_routes.begin();
  }
 
  const_iterator
  end() const noexcept
  {
    return m_routes.end();
  }
 
  iterator
  begin() noexcept
  {
    return m_routes.begin();
  }
 
  iterator
  end() noexcept
  {
    return m_routes.end();
  }
 
private:
  Name m_name;
  std::list<shared_ptr<RibEntry>> m_children;
  shared_ptr<RibEntry> m_parent;
  RouteList m_routes;
  RouteList m_inheritedRoutes;
 
  uint64_t m_nRoutesWithCaptureSet = 0;
};
 
std::ostream&
operator<<(std::ostream& os, const RibEntry& entry);
 
} // namespace nfd::rib
 
#endif // NFD_DAEMON_RIB_RIB_ENTRY_HPP