pit.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  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_TABLE_PIT_HPP
#define NFD_DAEMON_TABLE_PIT_HPP
 
#include "name-tree.hpp"
#include "pit-entry.hpp"
 
namespace nfd {
namespace pit {
 
using DataMatchResult = std::vector<shared_ptr<Entry>>;
 
class Iterator : public boost::forward_iterator_helper<Iterator, const Entry>
{
public:
  explicit
  Iterator(const NameTree::const_iterator& ntIt = {}, size_t iPitEntry = 0)
    : m_ntIt(ntIt)
    , m_iPitEntry(iPitEntry)
  {
  }
 
  const Entry&
  operator*() const noexcept
  {
    BOOST_ASSERT(m_ntIt != NameTree::const_iterator());
    BOOST_ASSERT(m_iPitEntry < m_ntIt->getPitEntries().size());
    return *m_ntIt->getPitEntries()[m_iPitEntry];
  }
 
  Iterator&
  operator++();
 
  friend bool
  operator==(const Iterator& lhs, const Iterator& rhs) noexcept
  {
    return lhs.m_ntIt == rhs.m_ntIt &&
           lhs.m_iPitEntry == rhs.m_iPitEntry;
  }
 
private:
  NameTree::const_iterator m_ntIt; 
  size_t m_iPitEntry; 
};
 
class Pit : noncopyable
{
public:
  explicit
  Pit(NameTree& nameTree);
 
  size_t
  size() const
  {
    return m_nItems;
  }
 
  shared_ptr<Entry>
  find(const Interest& interest) const
  {
    return const_cast<Pit*>(this)->findOrInsert(interest, false).first;
  }
 
  std::pair<shared_ptr<Entry>, bool>
  insert(const Interest& interest)
  {
    return this->findOrInsert(interest, true);
  }
 
  DataMatchResult
  findAllDataMatches(const Data& data) const;
 
  void
  erase(Entry* entry)
  {
    this->erase(entry, true);
  }
 
  void
  deleteInOutRecords(Entry* entry, const Face& face);
 
public: // enumeration
  using const_iterator = Iterator;
 
  const_iterator
  begin() const;
 
  const_iterator
  end() const
  {
    return Iterator();
  }
 
private:
  void
  erase(Entry* pitEntry, bool canDeleteNte);
 
  std::pair<shared_ptr<Entry>, bool>
  findOrInsert(const Interest& interest, bool allowInsert);
 
private:
  NameTree& m_nameTree;
  size_t m_nItems = 0;
};
 
} // namespace pit
 
using pit::Pit;
 
} // namespace nfd
 
#endif // NFD_DAEMON_TABLE_PIT_HPP