blob: b442e4a06e74d336ef9f182f817daa3694f663bf [file] [log] [blame]
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2012-2013 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_CONTENT_STORE_WITH_PROBABILITY_H_
22#define NDN_CONTENT_STORE_WITH_PROBABILITY_H_
23
Spyridon Mastorakis53e922f2014-10-17 17:29:26 -070024#include "ns3/ndnSIM/model/ndn-common.hpp"
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070025
Alexander Afanasyev0c395372014-12-20 15:54:02 -080026#include "content-store-impl.hpp"
27
28#include "../../utils/trie/multi-policy.hpp"
29#include "custom-policies/probability-policy.hpp"
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070030#include "ns3/double.h"
31#include "ns3/type-id.h"
32
33namespace ns3 {
34namespace ndn {
35namespace cs {
36
37/**
38 * @ingroup ndn-cs
39 * @brief Special content store realization that honors Freshness parameter in Data packets
40 */
41template<class Policy>
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080042class ContentStoreWithProbability
43 : public ContentStoreImpl<ndnSIM::multi_policy_traits<boost::mpl::
44 vector2<ndnSIM::probability_policy_traits,
45 Policy>>> {
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070046public:
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080047 typedef ContentStoreImpl<ndnSIM::multi_policy_traits<boost::mpl::
48 vector2<ndnSIM::probability_policy_traits,
49 Policy>>> super;
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070050
51 typedef typename super::policy_container::template index<0>::type probability_policy_container;
52
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080053 ContentStoreWithProbability(){};
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070054
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080055 static TypeId
56 GetTypeId();
57
58private:
59 void
60 SetCacheProbability(double probability)
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070061 {
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080062 this->getPolicy().template get<probability_policy_container>().set_probability(probability);
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070063 }
64
65 double
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080066 GetCacheProbability() const
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070067 {
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080068 return this->getPolicy().template get<probability_policy_container>().get_probability();
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070069 }
70};
71
72//////////////////////////////////////////
73////////// Implementation ////////////////
74//////////////////////////////////////////
75
76template<class Policy>
77TypeId
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080078ContentStoreWithProbability<Policy>::GetTypeId()
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070079{
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080080 static TypeId tid =
81 TypeId(("ns3::ndn::cs::Probability::" + Policy::GetName()).c_str())
82 .SetGroupName("Ndn")
83 .SetParent<super>()
84 .template AddConstructor<ContentStoreWithProbability<Policy>>()
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070085
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080086 .AddAttribute("CacheProbability",
87 "Set probability of caching in ContentStore. "
88 "If 1, every content is cached. If 0, no content is cached.",
89 DoubleValue(1.0), //(+)
90 MakeDoubleAccessor(&ContentStoreWithProbability<Policy>::GetCacheProbability,
91 &ContentStoreWithProbability<Policy>::SetCacheProbability),
92 MakeDoubleChecker<double>());
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070093
94 return tid;
95}
96
Alexander Afanasyevcd31abd2013-09-05 20:45:02 -070097} // namespace cs
98} // namespace ndn
99} // namespace ns3
100
101#endif // NDN_CONTENT_STORE_WITH_PROBABILITY_H_