NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
cache-policy.cpp
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2013-2019 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
#include "
ndn-cxx/lp/cache-policy.hpp
"
25
#include "
ndn-cxx/encoding/block-helpers.hpp
"
26
27
namespace
ndn
{
28
namespace
lp
{
29
30
std::ostream&
31
operator<<
(std::ostream& os,
CachePolicyType
policy)
32
{
33
switch
(policy) {
34
case
CachePolicyType::NO_CACHE
:
35
return
os <<
"NoCache"
;
36
default
:
37
return
os <<
"None"
;
38
}
39
}
40
41
CachePolicy::CachePolicy
()
42
: m_policy(
CachePolicyType
::NONE)
43
{
44
}
45
46
CachePolicy::CachePolicy
(
const
Block
& block)
47
{
48
wireDecode
(block);
49
}
50
51
template
<encoding::Tag TAG>
52
size_t
53
CachePolicy::wireEncode
(
EncodingImpl<TAG>
& encoder)
const
54
{
55
if
(m_policy ==
CachePolicyType::NONE
) {
56
NDN_THROW
(
Error
(
"CachePolicyType must be set"
));
57
}
58
59
size_t
length = 0;
60
length +=
prependNonNegativeIntegerBlock
(encoder,
tlv::CachePolicyType
,
static_cast<
uint32_t
>
(m_policy));
61
length += encoder.prependVarNumber(length);
62
length += encoder.prependVarNumber(
tlv::CachePolicy
);
63
return
length;
64
}
65
66
NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS
(
CachePolicy
);
67
68
const
Block
&
69
CachePolicy::wireEncode
()
const
70
{
71
if
(m_policy ==
CachePolicyType::NONE
) {
72
NDN_THROW
(
Error
(
"CachePolicyType must be set"
));
73
}
74
75
if
(m_wire.
hasWire
()) {
76
return
m_wire;
77
}
78
79
EncodingEstimator
estimator;
80
size_t
estimatedSize =
wireEncode
(estimator);
81
82
EncodingBuffer
buffer(estimatedSize, 0);
83
wireEncode
(buffer);
84
85
m_wire = buffer.block();
86
87
return
m_wire;
88
}
89
90
void
91
CachePolicy::wireDecode
(
const
Block
& wire)
92
{
93
if
(wire.
type
() !=
tlv::CachePolicy
) {
94
NDN_THROW
(
Error
(
"CachePolicy"
, wire.
type
()));
95
}
96
97
m_wire = wire;
98
m_wire.
parse
();
99
100
auto
it = m_wire.
elements_begin
();
101
if
(it == m_wire.
elements_end
()) {
102
NDN_THROW
(
Error
(
"Empty CachePolicy"
));
103
}
104
105
if
(it->type() ==
tlv::CachePolicyType
) {
106
m_policy =
static_cast<
CachePolicyType
>
(
readNonNegativeInteger
(*it));
107
if
(this->
getPolicy
() ==
CachePolicyType::NONE
) {
108
NDN_THROW
(
Error
(
"Unknown CachePolicyType"
));
109
}
110
}
111
else
{
112
NDN_THROW
(
Error
(
"CachePolicyType"
, it->type()));
113
}
114
}
115
116
CachePolicyType
117
CachePolicy::getPolicy
()
const
118
{
119
switch
(m_policy) {
120
case
CachePolicyType::NO_CACHE
:
121
return
m_policy;
122
default
:
123
return
CachePolicyType::NONE
;
124
}
125
}
126
127
CachePolicy
&
128
CachePolicy::setPolicy
(
CachePolicyType
policy)
129
{
130
m_policy = policy;
131
m_wire.
reset
();
132
return
*
this
;
133
}
134
135
}
// namespace lp
136
}
// namespace ndn
ndn::lp::CachePolicyType
CachePolicyType
indicates the cache policy applied to a Data packet
Definition:
cache-policy.hpp:36
ndn::lp::CachePolicyType::NO_CACHE
@ NO_CACHE
ndn::lp::CachePolicy::getPolicy
CachePolicyType getPolicy() const
Definition:
cache-policy.cpp:117
ndn::lp::CachePolicy::CachePolicy
CachePolicy()
Definition:
cache-policy.cpp:41
ndn::Block::elements_begin
element_const_iterator elements_begin() const
Equivalent to elements().begin()
Definition:
block.hpp:399
ndn::lp::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS
NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(CachePolicy)
ndn::lp::CachePolicy::Error
Definition:
cache-policy.hpp:51
ndn::lp::CachePolicy::setPolicy
CachePolicy & setPolicy(CachePolicyType policy)
set policy type code
Definition:
cache-policy.cpp:128
ndn::Block::reset
void reset() noexcept
Reset the Block to a default-constructed state.
Definition:
block.cpp:250
ndn::lp::tlv::CachePolicyType
@ CachePolicyType
Definition:
tlv.hpp:47
ndn::lp::CachePolicy
represents a CachePolicy header field
Definition:
cache-policy.hpp:48
ndn::encoding::EncodingEstimator
EncodingImpl< EstimatorTag > EncodingEstimator
Definition:
encoding-buffer-fwd.hpp:39
ndn::encoding::readNonNegativeInteger
uint64_t readNonNegativeInteger(const Block &block)
Read a non-negative integer from a TLV element.
Definition:
block-helpers.cpp:64
ndn::lp::operator<<
std::ostream & operator<<(std::ostream &os, CachePolicyType policy)
Definition:
cache-policy.cpp:31
ndn::Block::type
uint32_t type() const
Return the TLV-TYPE of the Block.
Definition:
block.hpp:274
cache-policy.hpp
NDN_THROW
#define NDN_THROW(e)
Definition:
exception.hpp:61
ndn::lp::CachePolicyType::NONE
@ NONE
ndn::lp::CachePolicy::wireDecode
void wireDecode(const Block &wire)
get CachePolicyType from wire format
Definition:
cache-policy.cpp:91
ndn::Block::parse
void parse() const
Parse TLV-VALUE into sub-elements.
Definition:
block.cpp:325
ndn::encoding::prependNonNegativeIntegerBlock
size_t prependNonNegativeIntegerBlock(EncodingImpl< TAG > &encoder, uint32_t type, uint64_t value)
Prepend a TLV element containing a non-negative integer.
Definition:
block-helpers.cpp:35
ndn::lp::CachePolicy::wireEncode
const Block & wireEncode() const
encode CachePolicy into wire format
Definition:
cache-policy.cpp:69
ndn::encoding::EncodingImpl
Definition:
encoding-buffer-fwd.hpp:36
block-helpers.hpp
ndn::Block
Represents a TLV element of NDN packet format.
Definition:
block.hpp:43
ndn::Block::elements_end
element_const_iterator elements_end() const
Equivalent to elements().end()
Definition:
block.hpp:407
ndn::Block::hasWire
bool hasWire() const noexcept
Check if the Block contains a fully encoded wire representation.
Definition:
block.hpp:230
ndn::lp
Definition:
cache-policy.cpp:28
ndn::lp::tlv::CachePolicy
@ CachePolicy
Definition:
tlv.hpp:46
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition:
ndn-strategy-choice-helper.hpp:34
ndn::encoding::EncodingBuffer
EncodingImpl< EncoderTag > EncodingBuffer
Definition:
encoding-buffer-fwd.hpp:38
ndnSIM
ndn-cxx
ndn-cxx
lp
cache-policy.cpp
Generated on Mon Jun 1 2020 22:32:14 for ndnSIM by
1.8.18