tests/daemon/fw/dummy-strategy.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
 * Copyright (c) 2014-2016,  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_TESTS_DAEMON_FW_DUMMY_STRATEGY_HPP
#define NFD_TESTS_DAEMON_FW_DUMMY_STRATEGY_HPP

#include "fw/strategy.hpp"

namespace nfd {
namespace tests {

/** \brief strategy for unit testing
 *
 *  Unless otherwise indicated, triggers are recorded but does nothing.
 */
class DummyStrategy : public fw::Strategy
{
public:
  static void
  registerAs(const Name& name)
  {
    if (!fw::Strategy::canCreate(name)) {
      fw::Strategy::registerType<DummyStrategy>(name);
    }
  }

  DummyStrategy(Forwarder& forwarder, const Name& name)
    : Strategy(forwarder)
    , afterReceiveInterest_count(0)
    , beforeSatisfyInterest_count(0)
    , beforeExpirePendingInterest_count(0)
    , afterReceiveNack_count(0)
  {
    this->setInstanceName(name);
  }

  /** \brief after receive Interest trigger
   *
   *  If \p interestOutFace is not null, Interest is forwarded to that face via send Interest action;
   *  otherwise, reject pending Interest action is invoked.
   */
  void
  afterReceiveInterest(const Face& inFace, const Interest& interest,
                       const shared_ptr<pit::Entry>& pitEntry) override
  {
    ++afterReceiveInterest_count;

    if (interestOutFace != nullptr) {
      this->sendInterest(pitEntry, *interestOutFace, interest);
    }
    else {
      this->rejectPendingInterest(pitEntry);
    }
  }

  void
  beforeSatisfyInterest(const shared_ptr<pit::Entry>& pitEntry,
                        const Face& inFace, const Data& data) override
  {
    ++beforeSatisfyInterest_count;
  }

  void
  beforeExpirePendingInterest(const shared_ptr<pit::Entry>& pitEntry) override
  {
    ++beforeExpirePendingInterest_count;
  }

  void
  afterReceiveNack(const Face& inFace, const lp::Nack& nack,
                   const shared_ptr<pit::Entry>& pitEntry) override
  {
    ++afterReceiveNack_count;
  }

public:
  int afterReceiveInterest_count;
  int beforeSatisfyInterest_count;
  int beforeExpirePendingInterest_count;
  int afterReceiveNack_count;

  shared_ptr<Face> interestOutFace;
};

} // namespace tests
} // namespace nfd

#endif // NFD_TESTS_DAEMON_FW_DUMMY_STRATEGY_HPP