blob: 415ab0b967bf603a3ca21279b47ad0b4be6cb5f6 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2011-2015 Regents of the University of California.
*
* This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and
* contributors.
*
* ndnSIM is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* ndnSIM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
#ifndef FRESHNESS_POLICY_H_
#define FRESHNESS_POLICY_H_
/// @cond include_hidden
#include "ns3/ndnSIM/model/ndn-common.hpp"
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
#include <ns3/nstime.h>
#include <ns3/simulator.h>
#include <ns3/traced-callback.h>
namespace ns3 {
namespace ndn {
namespace ndnSIM {
/**
* @brief Traits for freshness policy
*/
struct freshness_policy_traits {
/// @brief Name that can be used to identify the policy (for NS-3 object model and logging)
static std::string
GetName()
{
return "Freshness";
}
struct policy_hook_type : public boost::intrusive::set_member_hook<> {
Time timeWhenShouldExpire;
};
template<class Container>
struct container_hook {
typedef boost::intrusive::member_hook<Container, policy_hook_type, &Container::policy_hook_>
type;
};
template<class Base, class Container, class Hook>
struct policy {
static Time&
get_freshness(typename Container::iterator item)
{
return static_cast<typename policy_container::value_traits::hook_type*>(
policy_container::value_traits::to_node_ptr(*item))->timeWhenShouldExpire;
}
static const Time&
get_freshness(typename Container::const_iterator item)
{
return static_cast<const typename policy_container::value_traits::hook_type*>(
policy_container::value_traits::to_node_ptr(*item))->timeWhenShouldExpire;
}
template<class Key>
struct MemberHookLess {
bool
operator()(const Key& a, const Key& b) const
{
return get_freshness(&a) < get_freshness(&b);
}
};
typedef boost::intrusive::multiset<Container,
boost::intrusive::compare<MemberHookLess<Container>>,
Hook> policy_container;
class type : public policy_container {
public:
typedef policy policy_base; // to get access to get_freshness methods from outside
typedef Container parent_trie;
type(Base& base)
: base_(base)
, max_size_(100)
{
}
inline void
update(typename parent_trie::iterator item)
{
// do nothing
}
inline bool
insert(typename parent_trie::iterator item)
{
time::milliseconds freshness = item->payload()->GetData()->getFreshnessPeriod();
if (freshness > time::milliseconds::zero()) {
get_freshness(item) = Simulator::Now() + MilliSeconds(freshness.count());
// push item only if freshness is non zero. otherwise, this payload is not
// controlled by the policy.
// Note that .size() on this policy would return only the number of items with
// non-infinite freshness policy
policy_container::insert(*item);
}
return true;
}
inline void
lookup(typename parent_trie::iterator item)
{
// do nothing. it's random policy
}
inline void
erase(typename parent_trie::iterator item)
{
time::milliseconds freshness = item->payload()->GetData()->getFreshnessPeriod();
if (freshness > time::milliseconds::zero()) {
// erase only if freshness is positive (otherwise an item is not in the policy)
policy_container::erase(policy_container::s_iterator_to(*item));
}
}
inline void
clear()
{
policy_container::clear();
}
inline void
set_max_size(size_t max_size)
{
max_size_ = max_size;
}
inline size_t
get_max_size() const
{
return max_size_;
}
private:
type()
: base_(*((Base*)0)){};
private:
Base& base_;
size_t max_size_;
};
};
};
} // ndnSIM
} // ndn
} // ns3
/// @endcond
#endif // LIFETIME_STATS_POLICY_H