cs-policy-priority-fifo.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_CS_POLICY_PRIORITY_FIFO_HPP
#define NFD_DAEMON_TABLE_CS_POLICY_PRIORITY_FIFO_HPP
 
#include "cs-policy.hpp"
 
#include <ndn-cxx/util/scheduler.hpp>
 
#include <list>
 
namespace nfd::cs {
namespace priority_fifo {
 
using Queue = std::list<Policy::EntryRef>;
 
enum QueueType {
  QUEUE_UNSOLICITED,
  QUEUE_STALE,
  QUEUE_FIFO,
  QUEUE_MAX
};
 
struct EntryInfo
{
  QueueType queueType;
  Queue::iterator queueIt;
  ndn::scheduler::EventId moveStaleEventId;
};
 
class PriorityFifoPolicy final : public Policy
{
public:
  PriorityFifoPolicy();
 
  ~PriorityFifoPolicy() final;
 
private:
  void
  doAfterInsert(EntryRef i) final;
 
  void
  doAfterRefresh(EntryRef i) final;
 
  void
  doBeforeErase(EntryRef i) final;
 
  void
  doBeforeUse(EntryRef i) final;
 
  void
  evictEntries() final;
 
private:
  void
  evictOne();
 
  void
  attachQueue(EntryRef i);
 
  void
  detachQueue(EntryRef i);
 
  void
  moveToStaleQueue(EntryRef i);
 
public:
  static constexpr std::string_view POLICY_NAME{"priority_fifo"};
 
private:
  Queue m_queues[QUEUE_MAX];
  std::map<EntryRef, EntryInfo*> m_entryInfoMap;
};
 
} // namespace priority_fifo
 
using priority_fifo::PriorityFifoPolicy;
 
} // namespace nfd::cs
 
#endif // NFD_DAEMON_TABLE_CS_POLICY_PRIORITY_FIFO_HPP