blob: 2505a63b30c4b26f5a2c171e4a7613261b470dc1 [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyev7112f482011-08-17 14:05:57 -07002/*
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 */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070020
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070021#ifndef NDN_L3_PROTOCOL_H
22#define NDN_L3_PROTOCOL_H
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070023
24#include <list>
25#include <vector>
Alexander Afanasyev4975f732011-12-20 17:52:19 -080026
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070027#include "ns3/ptr.h"
28#include "ns3/net-device.h"
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -080029#include "ns3/nstime.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070030
31namespace ns3 {
32
33class Packet;
34class NetDevice;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070035class Node;
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070036class Header;
Ilya Moiseenko172763c2011-10-28 13:21:53 -070037
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070038namespace ndn {
39
40class Face;
41class ForwardingStrategy;
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070042class Interest;
43class ContentObject;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070044
Alexander Afanasyev73f06f62013-03-15 15:41:38 -070045typedef Interest InterestHeader;
46typedef ContentObject ContentObjectHeader;
47
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070048/**
49 * \defgroup ndn ndnSIM: NDN simulation module
50 *
51 * This is a simplified modular implementation of NDN protocol
52 */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070053/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070054 * \ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070055 * \brief Implementation network-layer of NDN stack
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070056 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070057 * This class defines the API to manipulate the following aspects of
58 * the NDN stack implementation:
59 * -# register a face (Face-derived object) for use by the NDN
60 * layer
61 *
62 * Each Face-derived object has conceptually a single NDN
63 * interface associated with it.
64 *
65 * In addition, this class defines NDN packet coding constants
66 *
67 * \see Face, ForwardingStrategy
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070068 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070069class L3Protocol :
70 public Object
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070071{
72public:
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -070073 typedef std::vector<Ptr<Face> > FaceList;
74
Alexander Afanasyev7112f482011-08-17 14:05:57 -070075 /**
76 * \brief Interface ID
77 *
78 * \return interface ID
79 */
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070080 static TypeId GetTypeId ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070081
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070082 static const uint16_t ETHERNET_FRAME_TYPE; ///< \brief Ethernet Frame Type of Ndn
83 // static const uint16_t IP_PROTOCOL_TYPE; ///< \brief IP protocol type of Ndn
84 // static const uint16_t UDP_PORT; ///< \brief UDP port of Ndn
Alexander Afanasyev7112f482011-08-17 14:05:57 -070085
86 /**
87 * \brief Default constructor. Creates an empty stack without forwarding strategy set
88 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070089 L3Protocol();
90 virtual ~L3Protocol ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070091
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070092 /**
93 * \brief Add face to Ndn stack
94 *
95 * \param face smart pointer to NdnFace-derived object
96 * (NdnLocalFace, NdnNetDeviceFace, NdnUdpFace) \returns the
97 * index of the Ndn interface added.
98 *
99 * \see NdnLocalFace, NdnNetDeviceFace, NdnUdpFace
100 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700101 virtual uint32_t
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700102 AddFace (const Ptr<Face> &face);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700103
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700104 /**
105 * \brief Get current number of faces added to Ndn stack
106 *
107 * \returns the number of faces
108 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700109 virtual uint32_t
110 GetNFaces () const;
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700111
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700112 /**
113 * \brief Get face by face index
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700114 * \param face The face number (number in face list)
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700115 * \returns The NdnFace associated with the Ndn face number.
116 */
117 virtual Ptr<Face>
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700118 GetFace (uint32_t face) const;
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700119
120 /**
121 * \brief Get face by face ID
122 * \param face The face ID number
123 * \returns The NdnFace associated with the Ndn face number.
124 */
125 virtual Ptr<Face>
126 GetFaceById (uint32_t face) const;
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700127
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700128 /**
129 * \brief Remove face from ndn stack (remove callbacks)
130 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700131 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700132 RemoveFace (Ptr<Face> face);
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800133
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700134 /**
135 * \brief Get face for NetDevice
136 */
137 virtual Ptr<Face>
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800138 GetFaceByNetDevice (Ptr<NetDevice> netDevice) const;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700139
Alexander Afanasyevff229772012-09-03 13:30:29 -0700140 static uint64_t
141 GetInterestCounter ();
142
143 static uint64_t
144 GetDataCounter ();
145
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800146private:
147 void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700148 Receive (const Ptr<Face> &face, const Ptr<const Packet> &p);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700149
150protected:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700151 virtual void DoDispose (void); ///< @brief Do cleanup
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700152
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700153 /**
154 * This function will notify other components connected to the node that a new stack member is now connected
155 * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.
156 */
157 virtual void NotifyNewAggregate ();
Alexander Afanasyev98256102011-08-14 01:00:02 -0700158
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700159private:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700160 L3Protocol(const L3Protocol &); ///< copy constructor is disabled
161 L3Protocol &operator = (const L3Protocol &); ///< copy operator is disabled
Alexander Afanasyevff8c5d62012-04-25 15:14:51 -0700162
Alexander Afanasyev98256102011-08-14 01:00:02 -0700163private:
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700164 uint32_t m_faceCounter; ///< \brief counter of faces. Increased every time a new face is added to the stack
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700165 FaceList m_faces; ///< \brief list of faces that belongs to ndn stack on this node
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700166
Alexander Afanasyevff229772012-09-03 13:30:29 -0700167 static uint64_t s_interestCounter;
168 static uint64_t s_dataCounter;
169
Alexander Afanasyev3a4a0b32012-06-28 14:14:22 -0700170 // These objects are aggregated, but for optimization, get them here
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700171 Ptr<Node> m_node; ///< \brief node on which ndn stack is installed
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700172 Ptr<ForwardingStrategy> m_forwardingStrategy; ///< \brief smart pointer to the selected forwarding strategy
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700173};
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700174
175} // namespace ndn
176} // namespace ns3
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700177
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700178#endif /* NDN_L3_PROTOCOL_H */