NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
cache-policy.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2017 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  *
21  * @author Eric Newberry <enewberry@email.arizona.edu>
22  */
23 
24 #ifndef NDN_CXX_LP_CACHE_POLICY_HPP
25 #define NDN_CXX_LP_CACHE_POLICY_HPP
26 
27 #include "../encoding/encoding-buffer.hpp"
28 #include "tlv.hpp"
29 
30 namespace ndn {
31 namespace lp {
32 
36 enum class CachePolicyType {
37  NONE = 0,
38  NO_CACHE = 1
39 };
40 
41 std::ostream&
42 operator<<(std::ostream& os, CachePolicyType policy);
43 
48 {
49 public:
50  class Error : public ndn::tlv::Error
51  {
52  public:
53  explicit
54  Error(const std::string& what)
55  : ndn::tlv::Error(what)
56  {
57  }
58  };
59 
60  CachePolicy();
61 
62  explicit
63  CachePolicy(const Block& block);
64 
70  template<encoding::Tag TAG>
71  size_t
72  wireEncode(EncodingImpl<TAG>& encoder) const;
73 
77  const Block&
78  wireEncode() const;
79 
83  void
84  wireDecode(const Block& wire);
85 
86 public: // policy type
92  getPolicy() const;
93 
99  setPolicy(CachePolicyType policy);
100 
101 private:
102  CachePolicyType m_policy;
103  mutable Block m_wire;
104 };
105 
107 
108 } // namespace lp
109 } // namespace ndn
110 
111 #endif // NDN_CXX_LP_CACHE_POLICY_HPP
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(CachePolicy)
void wireDecode(const Block &wire)
get CachePolicyType from wire format
represents a CachePolicy header field
Copyright (c) 2011-2015 Regents of the University of California.
Error(const std::string &what)
CachePolicy & setPolicy(CachePolicyType policy)
set policy type code
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
const Block & wireEncode() const
encode CachePolicy into wire format
CachePolicyType
indicates the cache policy applied to a Data packet
CachePolicyType getPolicy() const
std::ostream & operator<<(std::ostream &os, CachePolicyType policy)
represents an error in TLV encoding or decoding
Definition: tlv.hpp:50