blob: 730ce2afb5c35e44d6e6009d5ca5209cd927c0dd [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -07002/*
Ilya Moiseenko956d0542012-01-02 15:26:40 -08003 * Copyright (c) 2011 University of California, Los Angeles
Alexander Afanasyev08d984e2011-08-13 19:20:22 -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
17 *
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070018 * Authors: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070019 */
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070020
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070021#ifndef NDN_FACE_H
22#define NDN_FACE_H
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070023
Alexander Afanasyev98256102011-08-14 01:00:02 -070024#include <ostream>
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080025#include <algorithm>
Alexander Afanasyev98256102011-08-14 01:00:02 -070026
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070027#include "ns3/ptr.h"
Alexander Afanasyevcf6dc922012-08-10 16:55:27 -070028#include "ns3/object.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080029#include "ns3/nstime.h"
Alexander Afanasyev7f3e49e2012-04-30 00:17:07 -070030#include "ns3/type-id.h"
Alexander Afanasyevcf6dc922012-08-10 16:55:27 -070031#include "ns3/traced-callback.h"
Alexander Afanasyevea9b3e62012-08-13 19:02:54 -070032#include "ns3/ndn-limits.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070033
34namespace ns3 {
35
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070036class Packet;
37class Node;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070038
39namespace ndn {
40
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070041/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070042 * \ingroup ndn
43 * \defgroup ndn-face Faces
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070044 */
45/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070046 * \ingroup ndn-face
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070047 * \brief Virtual class defining NDN face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070048 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070049 * This class defines basic functionality of NDN face. Face is core
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070050 * component responsible for actual delivery of data packet to and
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070051 * from NDN stack
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070052 *
Alexander Afanasyevc57a8772013-03-16 11:55:20 -070053 * \see ndn::AppFace, ndn::NetDeviceFace
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070054 */
Alexander Afanasyevcf6dc922012-08-10 16:55:27 -070055class Face :
56 public Object
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070057{
58public:
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080059 static TypeId
60 GetTypeId ();
61
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070062 /**
Alexander Afanasyevc57a8772013-03-16 11:55:20 -070063 * \brief NDN protocol handler
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070064 *
65 * \param face Face from which packet has been received
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080066 * \param packet Original packet
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070067 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070068 typedef Callback<void,const Ptr<Face>&,const Ptr<const Packet>& > ProtocolHandler;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070069
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070070 /**
71 * \brief Default constructor
72 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070073 Face (Ptr<Node> node);
74 virtual ~Face();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070075
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070076 /**
77 * @brief Get node to which this face is associated
78 */
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080079 Ptr<Node>
80 GetNode () const;
81
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070082 ////////////////////////////////////////////////////////////////////
83
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070084 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070085 * \brief Register callback to call when new packet arrives on the face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070086 *
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070087 * This method should call protocol-dependent registration function
88 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080089 virtual void
90 RegisterProtocolHandler (ProtocolHandler handler);
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070091
92 /**
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080093 * \brief Send packet on a face
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070094 *
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080095 * This method will be called by lower layers to send data to device or application
96 *
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080097 * \param p smart pointer to a packet to send
98 *
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080099 * @return false if either limit is reached
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800100 */
101 bool
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800102 Send (Ptr<Packet> p);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800103
104 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700105 * \brief Receive packet from application or another node and forward it to the Ndn stack
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800106 *
107 * \todo The only reason for this call is to handle tracing, if requested
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700108 */
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800109 bool
110 Receive (const Ptr<const Packet> &p);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800111 ////////////////////////////////////////////////////////////////////
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700112
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800113 /**
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800114 * \brief Assign routing/forwarding metric with face
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800115 *
116 * \param metric configured routing metric (cost) of this face
117 */
118 virtual void SetMetric (uint16_t metric);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700119
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800120 /**
121 * \brief Get routing/forwarding metric assigned to the face
122 *
123 * \returns configured routing/forwarding metric (cost) of this face
124 */
125 virtual uint16_t GetMetric (void) const;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700126
127 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700128 * These are face states and may be distinct from actual lower-layer
129 * device states, such as found in real implementations (where the
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700130 * device may be down but ndn face state is still up).
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700131 */
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700132
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700133 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800134 * \brief Enable or disable this face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700135 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800136 virtual void
137 SetUp (bool up = true);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700138
139 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700140 * \brief Returns true if this face is enabled, false otherwise.
141 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800142 virtual bool
143 IsUp () const;
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700144
145 /**
146 * @brief Print information about the face into the stream
147 * @param os stream to write information to
148 */
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700149 virtual std::ostream&
150 Print (std::ostream &os) const;
151
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700152 /**
Alexander Afanasyevc57a8772013-03-16 11:55:20 -0700153 * \brief Set face Id
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700154 *
155 * Id is purely informative and should not be used for any other purpose
156 *
157 * \param id id to set
158 */
159 inline void
160 SetId (uint32_t id);
161
162 /**
Alexander Afanasyevc57a8772013-03-16 11:55:20 -0700163 * \brief Get face Id
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700164 *
165 * Id is purely informative and should not be used for any other purpose
166 *
167 * \returns id id to set
168 */
169 inline uint32_t
170 GetId () const;
171
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700172 /**
173 * \brief Compare two faces. Only two faces on the same node could be compared.
174 *
175 * Internal index is used for comparison.
176 */
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700177 bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700178 operator== (const Face &face) const;
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700179
180 /**
181 * \brief Compare two faces. Only two faces on the same node could be compared.
182 *
183 * Internal index is used for comparison.
184 */
Alexander Afanasyev0845c092012-07-13 17:45:33 -0700185 inline bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700186 operator!= (const Face &face) const;
Alexander Afanasyev0845c092012-07-13 17:45:33 -0700187
188 /**
189 * \brief Compare two faces. Only two faces on the same node could be compared.
190 *
191 * Internal index is used for comparison.
192 */
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700193 bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700194 operator< (const Face &face) const;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700195
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800196protected:
197 /**
198 * \brief Send packet on a face (actual implementation)
199 *
200 * \param p smart pointer to a packet to send
201 */
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700202 virtual bool
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800203 SendImpl (Ptr<Packet> p) = 0;
204
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700205private:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700206 Face (const Face &); ///< \brief Disabled copy constructor
207 Face& operator= (const Face &); ///< \brief Disabled copy operator
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700208
209protected:
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700210 Ptr<Node> m_node; ///< \brief Smart pointer to Node
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800211
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700212private:
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700213 ProtocolHandler m_protocolHandler; ///< Callback via which packets are getting send to Ndn stack
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700214 bool m_ifup; ///< \brief flag indicating that the interface is UP
Alexander Afanasyevc57a8772013-03-16 11:55:20 -0700215 uint32_t m_id; ///< \brief id of the interface in NDN stack (per-node uniqueness)
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800216 uint32_t m_metric; ///< \brief metric of the face
217
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700218 TracedCallback<Ptr<const Packet> > m_txTrace;
219 TracedCallback<Ptr<const Packet> > m_rxTrace;
220 TracedCallback<Ptr<const Packet> > m_dropTrace;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700221};
222
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700223std::ostream& operator<< (std::ostream& os, const Face &face);
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700224
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700225inline bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700226operator < (const Ptr<Face> &lhs, const Ptr<Face> &rhs)
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700227{
228 return *lhs < *rhs;
229}
230
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700231void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700232Face::SetId (uint32_t id)
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700233{
234 m_id = id;
235}
236
237uint32_t
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700238Face::GetId () const
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700239{
240 return m_id;
241}
Alexander Afanasyev98256102011-08-14 01:00:02 -0700242
Alexander Afanasyev0845c092012-07-13 17:45:33 -0700243inline bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700244Face::operator!= (const Face &face) const
Alexander Afanasyev0845c092012-07-13 17:45:33 -0700245{
246 return !(*this == face);
247}
248
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700249} // namespace ndn
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700250} // namespace ns3
251
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700252#endif // NDN_FACE_H