blob: fb7e449cee2d2d64e24aac0caf9c32f5bdf298f7 [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/*
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 *
Alexander Afanasyev5d79e682012-11-19 14:12:23 -080018 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070019 */
20
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080021#include "ndn-interest.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070022
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070023#include "ns3/log.h"
Alexander Afanasyevd9fecdd2012-06-08 16:22:24 -070024#include "ns3/unused.h"
Alexander Afanasyev663d63f2012-09-09 11:55:36 -070025#include "ns3/packet.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070026
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070027NS_LOG_COMPONENT_DEFINE ("ndn.Interest");
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070028
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070029namespace ns3 {
30namespace ndn {
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070031
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070032NS_OBJECT_ENSURE_REGISTERED (Interest);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070033
34TypeId
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070035Interest::GetTypeId (void)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070036{
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070037 static TypeId tid = TypeId ("ns3::ndn::Interest")
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070038 .SetGroupName ("Ndn")
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070039 .SetParent<Header> ()
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070040 .AddConstructor<Interest> ()
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070041 ;
42 return tid;
43}
44
45
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070046Interest::Interest ()
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070047 : m_name ()
Alexander Afanasyev5d79e682012-11-19 14:12:23 -080048 , m_scope (0xFF)
Alexander Afanasyev85a3bca2011-08-31 16:51:03 -070049 , m_interestLifetime (Seconds (0))
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070050 , m_nonce (0)
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080051 , m_nackType (NORMAL_INTEREST)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070052{
53}
54
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070055Interest::Interest (const Interest &interest)
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -070056 : m_name (Create<Name> (interest.GetName ()))
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070057 , m_scope (interest.m_scope)
58 , m_interestLifetime (interest.m_interestLifetime)
59 , m_nonce (interest.m_nonce)
60 , m_nackType (interest.m_nackType)
61{
62}
63
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070064Ptr<Interest>
65Interest::GetInterest (Ptr<Packet> packet)
Alexander Afanasyev663d63f2012-09-09 11:55:36 -070066{
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070067 Ptr<Interest> interest = Create<Interest> ();
Alexander Afanasyev663d63f2012-09-09 11:55:36 -070068 packet->RemoveHeader (*interest);
69
70 return interest;
71}
72
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070073void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070074Interest::SetName (Ptr<Name> name)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070075{
76 m_name = name;
77}
78
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -070079const Name&
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070080Interest::GetName () const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070081{
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070082 if (m_name==0) throw InterestException();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070083 return *m_name;
84}
85
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -070086Ptr<const Name>
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070087Interest::GetNamePtr () const
Alexander Afanasyev30f60e32012-07-10 14:21:16 -070088{
89 return m_name;
90}
91
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070092void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070093Interest::SetScope (int8_t scope)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070094{
95 m_scope = scope;
96}
97
98int8_t
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070099Interest::GetScope () const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700100{
101 return m_scope;
102}
103
104void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700105Interest::SetInterestLifetime (Time lifetime)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700106{
107 m_interestLifetime = lifetime;
108}
109
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700110Time
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700111Interest::GetInterestLifetime () const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700112{
113 return m_interestLifetime;
114}
115
116void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700117Interest::SetNonce (uint32_t nonce)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700118{
119 m_nonce = nonce;
120}
121
122uint32_t
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700123Interest::GetNonce () const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700124{
125 return m_nonce;
126}
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700127
128void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700129Interest::SetNack (uint8_t nackType)
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700130{
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800131 m_nackType = nackType;
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700132}
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800133
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800134uint8_t
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700135Interest::GetNack () const
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700136{
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800137 return m_nackType;
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700138}
Ilya Moiseenko75d9bf52011-10-28 13:18:32 -0700139
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700140uint32_t
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700141Interest::GetSerializedSize (void) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700142{
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800143 size_t size = 2 + (1 + 4 + 2 + 1 + (m_name->GetSerializedSize ()) + (2 + 0) + (2 + 0));
144 NS_LOG_INFO ("Serialize size = " << size);
145
146 return size;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700147}
148
149void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700150Interest::Serialize (Buffer::Iterator start) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700151{
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800152 start.WriteU8 (0x80); // version
153 start.WriteU8 (0x00); // packet type
154
155 start.WriteU32 (m_nonce);
156 start.WriteU8 (m_scope);
157 start.WriteU8 (m_nackType);
158
159 NS_ASSERT_MSG (0 <= m_interestLifetime.ToInteger (Time::S) && m_interestLifetime.ToInteger (Time::S) < 65535,
160 "Incorrect InterestLifetime (should not be smaller than 0 and larger than 65535");
161
162 // rounding timestamp value to seconds
163 start.WriteU16 (static_cast<uint16_t> (m_interestLifetime.ToInteger (Time::S)));
164
165 uint32_t offset = m_name->Serialize (start);
166 start.Next (offset);
167
168 start.WriteU16 (0); // no selectors
169 start.WriteU16 (0); // no options
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700170}
171
172uint32_t
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700173Interest::Deserialize (Buffer::Iterator start)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700174{
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800175 Buffer::Iterator i = start;
176
177 if (i.ReadU8 () != 0x80)
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700178 throw new InterestException ();
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800179
180 if (i.ReadU8 () != 0x00)
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700181 throw new InterestException ();
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800182
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -0800183 m_nonce = i.ReadU32 ();
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800184 m_scope = i.ReadU8 ();
185 m_nackType = i.ReadU8 ();
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -0800186
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800187 m_interestLifetime = Seconds (i.ReadU16 ());
188
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -0700189 m_name = Create<Name> ();
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -0800190 uint32_t offset = m_name->Deserialize (i);
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800191 i.Next (offset);
192
193 i.ReadU16 ();
194 i.ReadU16 ();
195
196 NS_ASSERT (GetSerializedSize () == (i.GetDistanceFrom (start)));
197
198 return i.GetDistanceFrom (start);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700199}
200
201TypeId
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700202Interest::GetInstanceTypeId (void) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700203{
204 return GetTypeId ();
205}
206
207void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700208Interest::Print (std::ostream &os) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700209{
Alexander Afanasyev7f3e49e2012-04-30 00:17:07 -0700210 os << "I: " << GetName ();
211
212 return;
Alexander Afanasyev85a3bca2011-08-31 16:51:03 -0700213 os << "<Interest>\n <Name>" << GetName () << "</Name>\n";
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800214 if (GetNack ()>0)
215 {
216 os << " <NACK>";
217 switch (GetNack ())
218 {
219 case NACK_LOOP:
220 os << "loop";
221 break;
222 case NACK_CONGESTION:
223 os << "congestion";
224 break;
225 default:
226 os << "unknown";
227 break;
228 }
229 os << "</NACK>\n";
230 }
Alexander Afanasyev5d79e682012-11-19 14:12:23 -0800231 os << " <Scope>" << GetScope () << "</Scope>\n";
Alexander Afanasyev85a3bca2011-08-31 16:51:03 -0700232 if ( !GetInterestLifetime ().IsZero() )
233 os << " <InterestLifetime>" << GetInterestLifetime () << "</InterestLifetime>\n";
234 if (GetNonce ()>0)
235 os << " <Nonce>" << GetNonce () << "</Nonce>\n";
236 os << "</Interest>";
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700237}
238
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700239} // namespace ndn
240} // namespace ns3
241