blob: 5713c7015bed6957f883e9c5fca03c9934f20182 [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 Afanasyev4aac5572012-08-09 10:49:55 -070032 * @ingroup ndn
33 * \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{
40public:
41 static TypeId GetTypeId ();
42
43 /**
44 * \brief Default constructor
45 */
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 Afanasyev2b4c9472012-08-09 15:00:38 -070050 // OnInterest (const Ptr<const InterestHeader> &interest);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080051
52 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070053 OnNack (const Ptr<const InterestHeader> &interest, Ptr<Packet> payload);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080054
55 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070056 OnContentObject (const Ptr<const ContentObjectHeader> &contentObject,
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080057 Ptr<Packet> payload);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080058
59 virtual void
60 OnTimeout (uint32_t sequenceNumber);
61
62protected:
63 /**
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070064 * \brief Constructs the Interest packet and sends it using a callback to the underlying NDN protocol
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080065 */
66 virtual void
67 ScheduleNextPacket ();
68
69private:
70 virtual void
71 SetWindow (uint32_t window);
72
73 uint32_t
74 GetWindow () const;
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080075
76 virtual void
77 SetPayloadSize (uint32_t payload);
78
79 uint32_t
80 GetPayloadSize () const;
81
82 double
83 GetMaxSize () const;
84
85 void
86 SetMaxSize (double size);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080087
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070088private:
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080089 uint32_t m_payloadSize; // expected payload size
90 double m_maxSize; // max size to request
91
Alexander Afanasyeve4c2ece2012-01-11 10:44:40 -080092 TracedValue<uint32_t> m_window;
Alexander Afanasyev06b42ec2012-01-11 19:05:36 -080093 TracedValue<uint32_t> m_inFlight;
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080094};
95
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070096} // namespace ndn
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080097} // namespace ns3
98
99#endif