blob: 1c1ed49b3255bfbf8c064b3919acdc7bb7fcc2b6 [file] [log] [blame]
Alexander Afanasyevf5c07742012-10-31 13:13:05 -07001/* -*- 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
21#ifndef _NDN_LIMITS_WINDOW_H_
22#define _NDN_LIMITS_WINDOW_H_
23
24#include "ndn-limits.h"
25
26namespace ns3 {
27namespace ndn {
28
29/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070030 * \ingroup ndn-fw
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070031 * \brief Structure to manage limits for outstanding interests (window-based limiting)
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070032 */
33class LimitsWindow :
34 public Limits
35{
36public:
37 typedef Limits super;
38
39 static TypeId
40 GetTypeId ();
41
42 /**
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070043 * @brief Default Constructor
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070044 */
45 LimitsWindow ()
46 : m_outstanding (0)
47 { }
48
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070049 /**
50 * @brief Virtual destructor
51 */
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070052 virtual
53 ~LimitsWindow () { }
54
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070055 // from ndn::Limits
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070056
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070057 virtual void
58 SetLimits (double rate, double delay)
59 {
60 super::SetLimits (rate, delay);
61
62 m_curMaxLimit = GetMaxRate () * GetMaxDelay ();
63 }
64
Alexander Afanasyeva8f5d882012-11-09 14:22:48 -080065 virtual
66 double
67 GetMaxLimit () const
68 {
69 return GetMaxRate () * GetMaxDelay ();
70 }
71
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070072 virtual void
73 UpdateCurrentLimit (double limit);
74
75 virtual double
76 GetCurrentLimit () const
77 {
78 return m_curMaxLimit;
79 }
80
Alexander Afanasyeva8f5d882012-11-09 14:22:48 -080081 virtual double
82 GetCurrentLimitRate () const
83 {
84 return m_curMaxLimit / GetMaxDelay ();
85 }
86
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070087 /**
88 * @brief Check if current interest window (number of pending interests) if less than maximum
89 */
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070090 virtual bool
91 IsBelowLimit ();
92
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070093 /**
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070094 * @brief Increase current window of outstanding interests
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070095 */
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070096 virtual void
97 BorrowLimit ();
Alexander Afanasyevf5c07742012-10-31 13:13:05 -070098
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070099 /**
100 * @brief Decrease current window of outstanding interests
101 */
102 virtual void
103 ReturnLimit ();
Alexander Afanasyevf5c07742012-10-31 13:13:05 -0700104
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700105private:
106 TracedValue< double > m_curMaxLimit;
Alexander Afanasyevf5c07742012-10-31 13:13:05 -0700107 TracedValue< double > m_outstanding;
108};
109
110
111} // namespace ndn
112} // namespace ns3
113
114#endif // _NDN_LIMITS_WINDOW_H_