blob: 552bd19963aafde5d2e1142b2deca7021e509f36 [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 Afanasyev73f06f62013-03-15 15:41:38 -070042
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070043/**
44 * \defgroup ndn ndnSIM: NDN simulation module
45 *
Alexander Afanasyevb989b122013-07-10 17:15:46 -070046 * This is a modular implementation of NDN protocol for NS-3
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070047 */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070048/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070049 * \ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070050 * \brief Implementation network-layer of NDN stack
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070051 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070052 * This class defines the API to manipulate the following aspects of
53 * the NDN stack implementation:
54 * -# register a face (Face-derived object) for use by the NDN
55 * layer
56 *
57 * Each Face-derived object has conceptually a single NDN
58 * interface associated with it.
59 *
60 * In addition, this class defines NDN packet coding constants
61 *
62 * \see Face, ForwardingStrategy
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070063 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070064class L3Protocol :
65 public Object
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070066{
67public:
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -070068 typedef std::vector<Ptr<Face> > FaceList;
69
Alexander Afanasyev7112f482011-08-17 14:05:57 -070070 /**
71 * \brief Interface ID
72 *
73 * \return interface ID
74 */
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070075 static TypeId GetTypeId ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070076
Alexander Afanasyev016a5d82013-07-15 10:41:29 -070077 static const uint16_t ETHERNET_FRAME_TYPE; ///< @brief Ethernet Frame Type of Ndn
78 static const uint16_t IP_STACK_PORT; ///< @brief TCP/UDP port for NDN stack
79 // static const uint16_t IP_PROTOCOL_TYPE; ///< \brief IP protocol type of NDN
Alexander Afanasyev7112f482011-08-17 14:05:57 -070080
81 /**
82 * \brief Default constructor. Creates an empty stack without forwarding strategy set
83 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070084 L3Protocol();
85 virtual ~L3Protocol ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070086
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070087 /**
88 * \brief Add face to Ndn stack
89 *
90 * \param face smart pointer to NdnFace-derived object
91 * (NdnLocalFace, NdnNetDeviceFace, NdnUdpFace) \returns the
92 * index of the Ndn interface added.
93 *
94 * \see NdnLocalFace, NdnNetDeviceFace, NdnUdpFace
95 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070096 virtual uint32_t
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070097 AddFace (const Ptr<Face> &face);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070098
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070099 /**
100 * \brief Get current number of faces added to Ndn stack
101 *
102 * \returns the number of faces
103 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700104 virtual uint32_t
105 GetNFaces () const;
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700106
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700107 /**
108 * \brief Get face by face index
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700109 * \param face The face number (number in face list)
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700110 * \returns The NdnFace associated with the Ndn face number.
111 */
112 virtual Ptr<Face>
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700113 GetFace (uint32_t face) const;
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700114
115 /**
116 * \brief Get face by face ID
117 * \param face The face ID number
118 * \returns The NdnFace associated with the Ndn face number.
119 */
120 virtual Ptr<Face>
121 GetFaceById (uint32_t face) const;
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700122
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700123 /**
124 * \brief Remove face from ndn stack (remove callbacks)
125 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700126 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700127 RemoveFace (Ptr<Face> face);
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800128
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700129 /**
130 * \brief Get face for NetDevice
131 */
132 virtual Ptr<Face>
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800133 GetFaceByNetDevice (Ptr<NetDevice> netDevice) const;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700134
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700135protected:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700136 virtual void DoDispose (void); ///< @brief Do cleanup
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700137
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700138 /**
139 * This function will notify other components connected to the node that a new stack member is now connected
140 * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.
141 */
142 virtual void NotifyNewAggregate ();
Alexander Afanasyev98256102011-08-14 01:00:02 -0700143
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700144private:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700145 L3Protocol(const L3Protocol &); ///< copy constructor is disabled
146 L3Protocol &operator = (const L3Protocol &); ///< copy operator is disabled
Alexander Afanasyevff8c5d62012-04-25 15:14:51 -0700147
Alexander Afanasyev98256102011-08-14 01:00:02 -0700148private:
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700149 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 -0700150 FaceList m_faces; ///< \brief list of faces that belongs to ndn stack on this node
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700151
Alexander Afanasyev3a4a0b32012-06-28 14:14:22 -0700152 // These objects are aggregated, but for optimization, get them here
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700153 Ptr<Node> m_node; ///< \brief node on which ndn stack is installed
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700154 Ptr<ForwardingStrategy> m_forwardingStrategy; ///< \brief smart pointer to the selected forwarding strategy
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700155};
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700156
157} // namespace ndn
158} // namespace ns3
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700159
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700160#endif /* NDN_L3_PROTOCOL_H */