blob: 79211e5ac318311cda2594bfde670f8229205ad3 [file] [log] [blame]
Alexander Afanasyev359bfb72012-01-09 18:42:50 -08001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
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: Ilya Moiseenko <iliamo@cs.ucla.edu>
19 * Alexander Afanasyev <alexander.afanasyev@ucla.edu>
20 */
21
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070022#ifndef NDN_CONSUMER_WINDOW_H
23#define NDN_CONSUMER_WINDOW_H
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080024
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070025#include "ndn-consumer.h"
Alexander Afanasyeve4c2ece2012-01-11 10:44:40 -080026#include "ns3/traced-value.h"
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080027
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070028namespace ns3 {
29namespace ndn {
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080030
31/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070032 * @ingroup ndn-apps
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070033 * \brief Ndn application for sending out Interest packets (window-based)
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070034 *
35 * !!! ATTENTION !!! This is highly experimental and relies on experimental features of the simulator.
36 * Behavior may be unpredictable if used incorrectly.
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080037 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070038class ConsumerWindow: public Consumer
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080039{
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080040public:
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080041 static TypeId GetTypeId ();
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080042
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080043 /**
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080044 * \brief Default constructor
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080045 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070046 ConsumerWindow ();
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080047
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070048 // From App
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080049 // virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070050 // OnInterest (const Ptr<const Interest> &interest);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080051
52 virtual void
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -070053 OnNack (Ptr<const Interest> interest);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080054
55 virtual void
Alexander Afanasyev772f51b2013-08-01 18:53:25 -070056 OnData (Ptr<const Data> contentObject);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080057
58 virtual void
59 OnTimeout (uint32_t sequenceNumber);
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080060
Alexander Afanasyev79b2fb32013-04-12 11:24:55 -070061 virtual void
62 WillSendOutInterest (uint32_t sequenceNumber);
63
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080064protected:
65 /**
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070066 * \brief Constructs the Interest packet and sends it using a callback to the underlying NDN protocol
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080067 */
68 virtual void
69 ScheduleNextPacket ();
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080070
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080071private:
72 virtual void
73 SetWindow (uint32_t window);
74
75 uint32_t
76 GetWindow () const;
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080077
78 virtual void
79 SetPayloadSize (uint32_t payload);
80
81 uint32_t
82 GetPayloadSize () const;
83
84 double
85 GetMaxSize () const;
86
87 void
88 SetMaxSize (double size);
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -080089
Alexander Afanasyevfdd45412013-05-16 22:24:33 -070090 uint32_t
91 GetSeqMax () const;
92
93 void
94 SetSeqMax (uint32_t seqMax);
95
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070096private:
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080097 uint32_t m_payloadSize; // expected payload size
98 double m_maxSize; // max size to request
99
Alexander Afanasyevd1f7c7b2013-01-31 13:34:37 -0800100 uint32_t m_initialWindow;
101 bool m_setInitialWindowOnTimeout;
102
Alexander Afanasyeve4c2ece2012-01-11 10:44:40 -0800103 TracedValue<uint32_t> m_window;
Alexander Afanasyev06b42ec2012-01-11 19:05:36 -0800104 TracedValue<uint32_t> m_inFlight;
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800105};
106
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700107} // namespace ndn
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800108} // namespace ns3
109
110#endif