cs-policy.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NFD_DAEMON_TABLE_CS_POLICY_HPP
#define NFD_DAEMON_TABLE_CS_POLICY_HPP

#include "cs-internal.hpp"
#include "cs-entry-impl.hpp"

namespace nfd {
namespace cs {

class Cs;

class Policy : noncopyable
{
public: // registry
  template<typename P>
  static void
  registerPolicy()
  {
    const std::string& key = P::POLICY_NAME;
    Registry& registry = getRegistry();
    BOOST_ASSERT(registry.count(key) == 0);
    registry[key] = [] { return make_unique<P>(); };
  }

  static unique_ptr<Policy>
  create(const std::string& key);

public:
  explicit
  Policy(const std::string& policyName);

  virtual
  ~Policy() = default;

  const std::string&
  getName() const;

public:
  Cs*
  getCs() const;

  void
  setCs(Cs *cs);

  size_t
  getLimit() const;

  void
  setLimit(size_t nMaxEntries);

  signal::Signal<Policy, iterator> beforeEvict;

  void
  afterInsert(iterator i);

  void
  afterRefresh(iterator i);

  void
  beforeErase(iterator i);

  void
  beforeUse(iterator i);

protected:
  virtual void
  doAfterInsert(iterator i) = 0;

  virtual void
  doAfterRefresh(iterator i) = 0;

  virtual void
  doBeforeErase(iterator i) = 0;

  virtual void
  doBeforeUse(iterator i) = 0;

  virtual void
  evictEntries() = 0;

protected:
  DECLARE_SIGNAL_EMIT(beforeEvict)

private: // registry
  typedef std::function<unique_ptr<Policy>()> CreateFunc;
  typedef std::map<std::string, CreateFunc> Registry; // indexed by key

  static Registry&
  getRegistry();

private:
  std::string m_policyName;
  size_t m_limit;
  Cs* m_cs;
};

inline const std::string&
Policy::getName() const
{
  return m_policyName;
}

inline Cs*
Policy::getCs() const
{
  return m_cs;
}

inline void
Policy::setCs(Cs *cs)
{
  m_cs = cs;
}

inline size_t
Policy::getLimit() const
{
  return m_limit;
}

} // namespace cs
} // namespace nfd

#define NFD_REGISTER_CS_POLICY(P)                      \
static class NfdAuto ## P ## CsPolicyRegistrationClass \
{                                                      \
public:                                                \
  NfdAuto ## P ## CsPolicyRegistrationClass()          \
  {                                                    \
    ::nfd::cs::Policy::registerPolicy<P>();            \
  }                                                    \
} g_nfdAuto ## P ## CsPolicyRegistrationVariable

#endif // NFD_DAEMON_TABLE_CS_POLICY_HPP