blob: 23c15a5613d8933fcf16f169a95ed61e8a708c7c [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyev98256102011-08-14 01:00:02 -07002/*
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -07003 * Copyright (c) 2011 University of California, Los Angeles
Alexander Afanasyev98256102011-08-14 01:00:02 -07004 *
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
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070017 *
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070018 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 * Ilya Moiseenko <iliamo@cs.ucla.edu>
Alexander Afanasyev98256102011-08-14 01:00:02 -070020 */
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070021#ifndef CCNX_FORWARDING_STRATEGY_H
22#define CCNX_FORWARDING_STRATEGY_H
Alexander Afanasyev98256102011-08-14 01:00:02 -070023
24#include "ns3/packet.h"
25#include "ns3/callback.h"
26#include "ns3/object.h"
Alexander Afanasyevf377b332011-12-16 15:32:12 -080027#include "ns3/traced-callback.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070028
Alexander Afanasyev98256102011-08-14 01:00:02 -070029namespace ns3 {
30
Alexander Afanasyev98256102011-08-14 01:00:02 -070031class CcnxFace;
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070032class CcnxInterestHeader;
Alexander Afanasyevf377b332011-12-16 15:32:12 -080033class CcnxPit;
34class CcnxPitEntry;
Alexander Afanasyev98256102011-08-14 01:00:02 -070035
36/**
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070037 * \ingroup ccnx
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080038 * \brief Abstract base class for CCNx forwarding strategies
Alexander Afanasyev98256102011-08-14 01:00:02 -070039 */
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070040class CcnxForwardingStrategy : public Object
Alexander Afanasyev98256102011-08-14 01:00:02 -070041{
42public:
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080043 static TypeId GetTypeId (void);
44
45 /**
46 * @brief Default constructor
47 */
48 CcnxForwardingStrategy ();
49 virtual ~CcnxForwardingStrategy ();
50
51 /**
Ilya Moiseenko332add02011-12-24 17:21:25 -080052 * @brief Base method to propagate the interest according to the forwarding strategy
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080053 *
54 * @param pitEntry Reference to PIT entry (reference to corresponding FIB entry inside)
55 * @param incomingFace Incoming face
56 * @param header CcnxInterestHeader
57 * @param packet Original Interest packet
58 * @param sendCallback Send callback
59 *
60 * @return true if interest was successfully propagated, false if all options have failed
61 */
Alexander Afanasyev4fa5e842011-11-21 13:38:39 -080062 virtual bool
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080063 PropagateInterest (const CcnxPitEntry &pitEntry,
Alexander Afanasyev4fa5e842011-11-21 13:38:39 -080064 const Ptr<CcnxFace> &incomingFace,
65 Ptr<CcnxInterestHeader> &header,
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080066 const Ptr<const Packet> &packet) = 0;
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070067
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080068 /**
69 * @brief Set link to PIT for the forwarding strategy
70 *
71 * @param pit pointer to PIT
72 */
73 void
74 SetPit (Ptr<CcnxPit> pit);
Alexander Afanasyevf377b332011-12-16 15:32:12 -080075
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080076protected:
77 /**
Ilya Moiseenko332add02011-12-24 17:21:25 -080078 * @brief Propagate interest via a green interface. Fail, if no green interfaces available
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080079 *
80 * @param pitEntry Reference to PIT entry (reference to corresponding FIB entry inside)
81 * @param incomingFace Incoming face
82 * @param header CcnxInterestHeader
83 * @param packet Original Interest packet
84 * @param sendCallback Send callback
85 * @return true if interest was successfully propagated, false if all options have failed
86 *
87 * \see PropagateInterest
88 */
89 bool
90 PropagateInterestViaGreen (const CcnxPitEntry &pitEntry,
91 const Ptr<CcnxFace> &incomingFace,
92 Ptr<CcnxInterestHeader> &header,
93 const Ptr<const Packet> &packet);
Alexander Afanasyevf377b332011-12-16 15:32:12 -080094
95 TracedCallback<Ptr<const CcnxInterestHeader>, Ptr<const CcnxFace> > m_transmittedInterestsTrace;
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080096
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080097protected:
Ilya Moiseenkoea27f4e2011-10-28 13:19:07 -070098 Ptr<CcnxPit> m_pit;
Alexander Afanasyev98256102011-08-14 01:00:02 -070099};
100
101} //namespace ns3
102
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700103#endif /* CCNX_FORWARDING_STRATEGY_H */