blob: 1939a84eb6dd1df797685559e1cda015c904f8bd [file] [log] [blame]
Alexander Afanasyev996b4872012-07-17 17:07:56 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 University of California, Los Angeles
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 * Ilya Moiseenko <iliamo@cs.ucla.edu>
20 */
21
22
23#ifndef NDNSIM_BEST_ROUTE_H
24#define NDNSIM_BEST_ROUTE_H
25
26#include "green-yellow-red.h"
Alexander Afanasyev042b4a72012-11-09 17:47:48 -080027#include "ns3/log.h"
Alexander Afanasyev996b4872012-07-17 17:07:56 -070028
29namespace ns3 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070030namespace ndn {
31namespace fw {
Alexander Afanasyev996b4872012-07-17 17:07:56 -070032
33/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070034 * @ingroup ndn-fw
35 * @brief Best route strategy
Alexander Afanasyev996b4872012-07-17 17:07:56 -070036 */
37class BestRoute :
38 public GreenYellowRed
39{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070040private:
41 typedef GreenYellowRed super;
42
Alexander Afanasyev996b4872012-07-17 17:07:56 -070043public:
44 static TypeId
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045 GetTypeId ();
Alexander Afanasyev996b4872012-07-17 17:07:56 -070046
47 /**
Alexander Afanasyev042b4a72012-11-09 17:47:48 -080048 * @brief Helper function to retrieve logging name for the forwarding strategy
49 */
50 static std::string
51 GetLogName ();
52
53 /**
Alexander Afanasyev996b4872012-07-17 17:07:56 -070054 * @brief Default constructor
55 */
56 BestRoute ();
57
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070058 // from super
Alexander Afanasyev996b4872012-07-17 17:07:56 -070059 virtual bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070060 DoPropagateInterest (Ptr<Face> incomingFace,
Alexander Afanasyevb989b122013-07-10 17:15:46 -070061 Ptr<const Interest> interest,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070062 Ptr<pit::Entry> pitEntry);
Alexander Afanasyev042b4a72012-11-09 17:47:48 -080063protected:
64 static LogComponent g_log;
Alexander Afanasyev996b4872012-07-17 17:07:56 -070065};
66
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070067} // namespace fw
68} // namespace ndn
Alexander Afanasyev996b4872012-07-17 17:07:56 -070069} // namespace ns3
70
71#endif // NDNSIM_BEST_ROUTE_H