daemon/fw/client-control-strategy.hpp

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

#include "best-route-strategy.hpp"

namespace nfd {
namespace fw {

/** \brief a forwarding strategy controlled by client application
 *
 *  The consumer may specify the nexthop for an Interest in NDNLPv2 NextHopFaceId field.
 *  If NextHopFaceId field is omitted, the Interest is forwarded to
 *  the FIB nexthop with lowest routing cost.
 */
class ClientControlStrategy : public BestRouteStrategy
{
public:
  ClientControlStrategy(Forwarder& forwarder, const Name& name = STRATEGY_NAME);

  virtual
  ~ClientControlStrategy();

  virtual void
  afterReceiveInterest(const Face& inFace,
                       const Interest& interest,
                       shared_ptr<fib::Entry> fibEntry,
                       shared_ptr<pit::Entry> pitEntry) DECL_OVERRIDE;

public:
  static const Name STRATEGY_NAME;
};

} // namespace fw
} // namespace nfd

#endif // NFD_DAEMON_FW_CLIENT_CONTROL_STRATEGY_HPP