tests/other/fw/congestion-mark-strategy.hpp

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

#include "daemon/fw/best-route-strategy2.hpp"

namespace nfd {
namespace fw {

/** \brief Congestion Mark integration testing strategy version 1
 *
 *  This strategy adds a CongestionMark to each Interest it forwards. Otherwise, behaves like
 *  BestRouteStrategy2.
 *
 *  The value of the added CongestionMark can be specified through a strategy parameter (defaults
 *  to 1). In addition, an optional boolean parameter specifies whether the strategy will preserve
 *  existing CongestionMarks (default) or replace them.
 *
 *  \note This strategy is not EndpointId-aware.
 */
class CongestionMarkStrategy : public BestRouteStrategy2
{
public:
  explicit
  CongestionMarkStrategy(Forwarder& forwarder, const Name& name = getStrategyName());

  static const Name&
  getStrategyName();

  void
  afterReceiveInterest(const FaceEndpoint& ingress, const Interest& interest,
                       const shared_ptr<pit::Entry>& pitEntry) override;

private:
  uint64_t m_congestionMark;
  bool m_shouldPreserveMark;
};

} // namespace fw
} // namespace nfd

#endif // NFD_TESTS_OTHER_FW_CONGESTION_MARK_STRATEGY_HPP