Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 2 | /* |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 3 | * Copyright (c) 2011 University of California, Los Angeles |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 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 | * |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 19 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 20 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 21 | #ifndef _CCNX_H_ |
| 22 | #define _CCNX_H_ |
| 23 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 24 | #include "ns3/object.h" |
| 25 | #include "ns3/socket.h" |
| 26 | #include "ns3/callback.h" |
| 27 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 28 | #include "ccnx-face.h" |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 29 | |
| 30 | namespace ns3 { |
| 31 | |
| 32 | class Node; |
| 33 | class NetDevice; |
| 34 | class Packet; |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 35 | class CcnxForwardingStrategy; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 36 | |
| 37 | /** |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 38 | * \defgroup ccnx NDN abstraction |
| 39 | * |
| 40 | * This is an abstract implementation of NDN protocol |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 41 | */ |
| 42 | /** |
| 43 | * \ingroup ccnx |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 44 | * \brief Interface to manage Ccnx stack |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 45 | * |
| 46 | * This class defines the API to manipulate the following aspects of |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 47 | * the Ccnx stack implementation: |
| 48 | * -# register a face (CcnxFace-derived object) for use by the Ccnx |
| 49 | * layer |
| 50 | * -# register forwarding strategy (CcnxForwardingStrategy-derived |
| 51 | * object) to use by Ccnx stack |
| 52 | * -# export Ccnx configuration attributes |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 53 | * |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 54 | * Each CcnxFace-derived object has conceptually a single Ccnx |
| 55 | * interface associated with it. |
| 56 | * |
| 57 | * In addition, this class defines CCNx packet coding constants |
| 58 | * |
| 59 | * \see CcnxFace, CcnxForwardingStrategy |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 60 | */ |
| 61 | class Ccnx : public Object |
| 62 | { |
| 63 | public: |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 64 | /** |
| 65 | * \brief Interface ID |
| 66 | * |
| 67 | * \return interface ID |
| 68 | */ |
| 69 | static TypeId GetTypeId (); |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 72 | * \brief Send a packet to a specified face |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 73 | * |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 74 | * \param face face where to send this packet |
Alexander Afanasyev | ab1d560 | 2011-08-17 19:17:18 -0700 | [diff] [blame] | 75 | * \param packet fully prepared CCNx packet to send |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 76 | * |
| 77 | * Higher-level layers (forwarding strategy in particular) call this |
| 78 | * method to send a packet down the stack to the MAC and PHY layers. |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 79 | */ |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 80 | virtual void |
| 81 | Send (const Ptr<CcnxFace> &face, const Ptr<Packet> &packet) = 0; |
Alexander Afanasyev | ab1d560 | 2011-08-17 19:17:18 -0700 | [diff] [blame] | 82 | |
| 83 | /** |
| 84 | * \brief Lower layers calls this method after demultiplexing |
| 85 | * |
| 86 | * Lower-layer-dependent implementation of CcnxFace will do actual work |
| 87 | * to set up demultiplexing and call this function as a callback |
| 88 | * |
| 89 | * \param face face from which packet came from |
| 90 | * \param p the packet |
| 91 | */ |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 92 | virtual void |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 93 | Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p) = 0; |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 94 | |
| 95 | /** |
| 96 | * \brief Register a new forwarding strategy to be used by this Ccnx |
| 97 | * stack |
| 98 | * |
| 99 | * This call will replace any forwarding strategy that has been |
| 100 | * previously registered. |
| 101 | * |
| 102 | * \param forwardingStrategy smart pointer to CcnxForwardingStrategy |
| 103 | * object |
| 104 | */ |
| 105 | virtual void |
| 106 | SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy) = 0; |
| 107 | |
| 108 | /** |
| 109 | * \brief Get the forwarding strategy being used by this Ccnx stack |
| 110 | * |
| 111 | * \returns smart pointer to CcnxForwardingStrategy object, or null |
| 112 | * pointer if none |
| 113 | */ |
| 114 | virtual Ptr<CcnxForwardingStrategy> |
| 115 | GetForwardingStrategy (void) const = 0; |
| 116 | |
| 117 | /** |
| 118 | * \brief Add face to CCNx stack |
| 119 | * |
| 120 | * \param face smart pointer to CcnxFace-derived object |
| 121 | * (CcnxLocalFace, CcnxNetDeviceFace, CcnxUdpFace) \returns the |
| 122 | * index of the Ccnx interface added. |
| 123 | * |
| 124 | * \see CcnxLocalFace, CcnxNetDeviceFace, CcnxUdpFace |
| 125 | */ |
| 126 | virtual uint32_t |
| 127 | AddFace (const Ptr<CcnxFace> &face) = 0; |
| 128 | |
| 129 | /** |
| 130 | * \brief Get current number of faces added to CCNx stack |
| 131 | * |
| 132 | * \returns the number of faces |
| 133 | */ |
| 134 | virtual uint32_t |
| 135 | GetNFaces (void) const = 0; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 136 | |
| 137 | /** |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 138 | * \param face The face number of an Ccnx interface. |
| 139 | * \returns The CcnxFace associated with the Ccnx face number. |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 140 | */ |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 141 | virtual Ptr<CcnxFace> |
| 142 | GetFace (uint32_t face) const = 0; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 143 | }; |
| 144 | |
| 145 | } // namespace ns3 |
| 146 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 147 | #endif /* _CCNX_H_ */ |