blob: e2100c677f29872508a8069c89fcaee8ed3ff49a [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 Afanasyev98256102011-08-14 01:00:02 -070021#ifndef CCNX_FACE_H
22#define CCNX_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 Afanasyev09c7deb2011-11-23 14:50:10 -080028#include "ns3/ccnx.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080029#include "ns3/nstime.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070030
31namespace ns3 {
32
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070033class Packet;
34class Node;
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070035
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070036/**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070037 * \ingroup ccnx
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070038 * \defgroup ccnx-face Faces
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070039 */
40/**
41 * \ingroup ccnx-face
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070042 * \brief Virtual class defining CCNx face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070043 *
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070044 * This class defines basic functionality of CCNx face. Face is core
45 * component responsible for actual delivery of data packet to and
46 * from CCNx stack
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070047 *
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070048 * \see CcnxLocalFace, CcnxNetDeviceFace, CcnxIpv4Face, CcnxUdpFace
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070049 */
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080050class CcnxFace : public Object
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070051{
52public:
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080053 static TypeId
54 GetTypeId ();
55
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070056 /**
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080057 * \brief Ccnx protocol handler
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070058 *
59 * \param face Face from which packet has been received
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080060 * \param packet Original packet
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070061 */
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070062 typedef Callback<void,const Ptr<CcnxFace>&,const Ptr<const Packet>& > ProtocolHandler;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070063
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070064 /**
65 * \brief Default constructor
66 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080067 CcnxFace (Ptr<Node> node);
Alexander Afanasyev98256102011-08-14 01:00:02 -070068 virtual ~CcnxFace();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070069
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080070 Ptr<Node>
71 GetNode () const;
72
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070073 ////////////////////////////////////////////////////////////////////
74
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070075 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070076 * \brief Register callback to call when new packet arrives on the face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070077 *
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070078 * This method should call protocol-dependent registration function
79 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080080 virtual void
81 RegisterProtocolHandler (ProtocolHandler handler);
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070082
83 /**
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080084 * @brief Check if Interest limit is reached
85 *
86 * Side effect: if limit is not yet reached, the number of outstanding packets will be increased
87 *
88 * @returns true if Interest limit is not yet reached
89 */
90 bool
91 IsBelowLimit ();
92
93 /**
94 * \brief Send packet on a face
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070095 *
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080096 * This method will be called by lower layers to send data to device or application
97 *
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080098 * \param p smart pointer to a packet to send
99 *
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800100 * @return false if either limit is reached
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800101 */
102 bool
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800103 Send (Ptr<Packet> p);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800104
105 /**
106 * \brief Receive packet from application or another node and forward it to the CCNx stack
107 *
108 * \todo The only reason for this call is to handle tracing, if requested
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700109 */
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800110 bool
111 Receive (const Ptr<const Packet> &p);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800112 ////////////////////////////////////////////////////////////////////
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700113
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800114 /**
115 * \Brief Assign routing/forwarding metric with face
116 *
117 * \param metric configured routing metric (cost) of this face
118 */
119 virtual void SetMetric (uint16_t metric);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700120
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800121 /**
122 * \brief Get routing/forwarding metric assigned to the face
123 *
124 * \returns configured routing/forwarding metric (cost) of this face
125 */
126 virtual uint16_t GetMetric (void) const;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700127
128 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700129 * These are face states and may be distinct from actual lower-layer
130 * device states, such as found in real implementations (where the
131 * device may be down but ccnx face state is still up).
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700132 */
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700133
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700134 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800135 * \brief Enable or disable this face
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700136 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800137 virtual void
138 SetUp (bool up = true);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700139
140 /**
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700141 * \brief Returns true if this face is enabled, false otherwise.
142 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800143 virtual bool
144 IsUp () const;
Ilya Moiseenkoacac1ea2011-10-28 13:16:53 -0700145
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700146 virtual std::ostream&
147 Print (std::ostream &os) const;
148
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700149 /**
150 * \brief Set node Id
151 *
152 * Id is purely informative and should not be used for any other purpose
153 *
154 * \param id id to set
155 */
156 inline void
157 SetId (uint32_t id);
158
159 /**
160 * \brief Get node Id
161 *
162 * Id is purely informative and should not be used for any other purpose
163 *
164 * \returns id id to set
165 */
166 inline uint32_t
167 GetId () const;
168
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700169 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800170 * @brief Set maximum value for Interest allowance
171 *
172 * @param bucket maximum value for Interest allowance. If < 0, then limit will be disabled
173 */
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800174 void
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800175 SetBucketMax (double bucket);
176
177 /**
Alexander Afanasyev11453142011-11-25 16:13:33 -0800178 * @brief Set a normalized value (one second) for Interest allowance bucket leak
179 */
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800180 void
Alexander Afanasyev11453142011-11-25 16:13:33 -0800181 SetBucketLeak (double leak);
182
183 /**
Alexander Afanasyev4975f732011-12-20 17:52:19 -0800184 * @brief Leak the Interest allowance bucket by (1/interval) * m_bucketMax amount,
185 * where interval is time between two consecutive calls of LeakBucket
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800186 */
Alexander Afanasyevb5703a92011-11-25 16:46:15 -0800187 void
Alexander Afanasyev4975f732011-12-20 17:52:19 -0800188 LeakBucket ();
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800189
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800190 /**
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700191 * \brief Compare two faces. Only two faces on the same node could be compared.
192 *
193 * Internal index is used for comparison.
194 */
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700195 bool
196 operator== (const CcnxFace &face) const;
Alexander Afanasyev7fd74f92011-08-25 19:40:17 -0700197
198 /**
199 * \brief Compare two faces. Only two faces on the same node could be compared.
200 *
201 * Internal index is used for comparison.
202 */
203 bool
204 operator< (const CcnxFace &face) const;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700205
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800206protected:
207 /**
208 * \brief Send packet on a face (actual implementation)
209 *
210 * \param p smart pointer to a packet to send
211 */
212 virtual void
213 SendImpl (Ptr<Packet> p) = 0;
214
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700215private:
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700216 CcnxFace (const CcnxFace &); ///< \brief Disabled copy constructor
217 CcnxFace& operator= (const CcnxFace &); ///< \brief Disabled copy operator
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700218
219protected:
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700220 // uint16_t m_metric; ///< \brief Routing/forwarding metric
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700221 Ptr<Node> m_node; ///< \brief Smart pointer to Node
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800222
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800223 double m_bucket; ///< \brief Value representing current size of the Interest allowance for this face
224 double m_bucketMax; ///< \brief Maximum Interest allowance for this face
225 double m_bucketLeak; ///< \brief Normalized amount that should be leaked every second
226
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700227private:
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800228 ProtocolHandler m_protocolHandler; ///< Callback via which packets are getting send to CCNx stack
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700229 bool m_ifup; ///< \brief flag indicating that the interface is UP
Alexander Afanasyev4975f732011-12-20 17:52:19 -0800230 uint32_t m_id; ///< \brief id of the interface in CCNx stack (per-node uniqueness)
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800231 Time m_lastLeakTime;
232 uint32_t m_metric; ///< \brief metric of the face
233
234 bool m_enableMetricTagging;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700235};
236
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700237std::ostream& operator<< (std::ostream& os, const CcnxFace &face);
238
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700239inline bool
240operator < (const Ptr<CcnxFace> &lhs, const Ptr<CcnxFace> &rhs)
241{
242 return *lhs < *rhs;
243}
244
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700245void
246CcnxFace::SetId (uint32_t id)
247{
248 m_id = id;
249}
250
251uint32_t
252CcnxFace::GetId () const
253{
254 return m_id;
255}
Alexander Afanasyev98256102011-08-14 01:00:02 -0700256
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700257} // namespace ns3
258
Alexander Afanasyev98256102011-08-14 01:00:02 -0700259#endif //CCNX_FACE_H