pit-entry.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_ENTRY_HPP
#define NFD_DAEMON_TABLE_PIT_ENTRY_HPP
 
#include "strategy-info-host.hpp"
 
#include <ndn-cxx/util/scheduler.hpp>
 
#include <list>
 
namespace nfd {
 
namespace face {
class Face;
} // namespace face
using face::Face;
 
namespace name_tree {
class Entry;
} // namespace name_tree
 
namespace pit {
 
class FaceRecord : public StrategyInfoHost
{
public:
  explicit
  FaceRecord(Face& face)
    : m_face(face)
  {
  }
 
  Face&
  getFace() const noexcept
  {
    return m_face;
  }
 
  Interest::Nonce
  getLastNonce() const noexcept
  {
    return m_lastNonce;
  }
 
  time::steady_clock::time_point
  getLastRenewed() const noexcept
  {
    return m_lastRenewed;
  }
 
  time::steady_clock::time_point
  getExpiry() const noexcept
  {
    return m_expiry;
  }
 
  void
  update(const Interest& interest);
 
private:
  Face& m_face;
  Interest::Nonce m_lastNonce{0, 0, 0, 0};
  time::steady_clock::time_point m_lastRenewed = time::steady_clock::time_point::min();
  time::steady_clock::time_point m_expiry = time::steady_clock::time_point::min();
};
 
class InRecord : public FaceRecord
{
public:
  using FaceRecord::FaceRecord;
 
  const Interest&
  getInterest() const noexcept
  {
    BOOST_ASSERT(m_interest != nullptr);
    return *m_interest;
  }
 
  void
  update(const Interest& interest);
 
private:
  shared_ptr<const Interest> m_interest;
};
 
class OutRecord : public FaceRecord
{
public:
  using FaceRecord::FaceRecord;
 
  const lp::NackHeader*
  getIncomingNack() const noexcept
  {
    return m_incomingNack.get();
  }
 
  bool
  setIncomingNack(const lp::Nack& nack);
 
  void
  clearIncomingNack() noexcept
  {
    m_incomingNack.reset();
  }
 
private:
  unique_ptr<lp::NackHeader> m_incomingNack;
};
 
using InRecordCollection = std::list<InRecord>;
 
using OutRecordCollection = std::list<OutRecord>;
 
class Entry : public StrategyInfoHost, noncopyable
{
public:
  explicit
  Entry(const Interest& interest);
 
  const Interest&
  getInterest() const
  {
    return *m_interest;
  }
 
  const Name&
  getName() const
  {
    return m_interest->getName();
  }
 
  bool
  canMatch(const Interest& interest, size_t nEqualNameComps = 0) const;
 
public: // in-record
  const InRecordCollection&
  getInRecords() const noexcept
  {
    return m_inRecords;
  }
 
  bool
  hasInRecords() const noexcept
  {
    return !m_inRecords.empty();
  }
 
  InRecordCollection::iterator
  in_begin() noexcept
  {
    return m_inRecords.begin();
  }
 
  InRecordCollection::const_iterator
  in_begin() const noexcept
  {
    return m_inRecords.begin();
  }
 
  InRecordCollection::iterator
  in_end() noexcept
  {
    return m_inRecords.end();
  }
 
  InRecordCollection::const_iterator
  in_end() const noexcept
  {
    return m_inRecords.end();
  }
 
  InRecordCollection::iterator
  findInRecord(const Face& face) noexcept;
 
  InRecordCollection::iterator
  insertOrUpdateInRecord(Face& face, const Interest& interest);
 
  void
  deleteInRecord(InRecordCollection::const_iterator pos)
  {
    m_inRecords.erase(pos);
  }
 
  void
  clearInRecords() noexcept
  {
    m_inRecords.clear();
  }
 
public: // out-record
  const OutRecordCollection&
  getOutRecords() const noexcept
  {
    return m_outRecords;
  }
 
  bool
  hasOutRecords() const noexcept
  {
    return !m_outRecords.empty();
  }
 
  OutRecordCollection::iterator
  out_begin() noexcept
  {
    return m_outRecords.begin();
  }
 
  OutRecordCollection::const_iterator
  out_begin() const noexcept
  {
    return m_outRecords.begin();
  }
 
  OutRecordCollection::iterator
  out_end() noexcept
  {
    return m_outRecords.end();
  }
 
  OutRecordCollection::const_iterator
  out_end() const noexcept
  {
    return m_outRecords.end();
  }
 
  OutRecordCollection::iterator
  findOutRecord(const Face& face) noexcept;
 
  OutRecordCollection::iterator
  insertOrUpdateOutRecord(Face& face, const Interest& interest);
 
  void
  deleteOutRecord(const Face& face);
 
public:
  ndn::scheduler::EventId expiryTimer;
 
  bool isSatisfied = false;
 
  time::milliseconds dataFreshnessPeriod = 0_ms;
 
private:
  shared_ptr<const Interest> m_interest;
  InRecordCollection m_inRecords;
  OutRecordCollection m_outRecords;
 
  name_tree::Entry* m_nameTreeEntry = nullptr;
 
  friend ::nfd::name_tree::Entry;
};
 
} // namespace pit
} // namespace nfd
 
#endif // NFD_DAEMON_TABLE_PIT_ENTRY_HPP