ndn::lp::CachePolicy Class Reference

represents a CachePolicy header field More...

#include <ndn-cxx/lp/cache-policy.hpp>

Classes
class	Error

Public Member Functions
	CachePolicy ()
	CachePolicy (const Block &block)
CachePolicyType	getPolicy () const
CachePolicy &	setPolicy (CachePolicyType policy)
	set policy type code More...
void	wireDecode (const Block &wire)
	get CachePolicyType from wire format More...
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	prepend CachePolicy to encoder More...
const Block &	wireEncode () const
	encode CachePolicy into wire format More...

Detailed Description

represents a CachePolicy header field

Definition at line 47 of file cache-policy.hpp.

Constructor & Destructor Documentation

CachePolicy() [1/2]

ndn::lp::CachePolicy::CachePolicy

(

)

Definition at line 41 of file cache-policy.cpp.

CachePolicy() [2/2]

ndn::lp::CachePolicy::CachePolicy ( const Block &  block )

explicit

Definition at line 46 of file cache-policy.cpp.

Member Function Documentation

getPolicy()

CachePolicyType ndn::lp::CachePolicy::getPolicy

(

)

const

Returns

policy type code

Return values

CachePolicyType::NONE

if policy type is unset or has an unknown code

Definition at line 117 of file cache-policy.cpp.

setPolicy()

CachePolicy & ndn::lp::CachePolicy::setPolicy

(

CachePolicyType

policy

)

set policy type code

Parameters

policy

a policy type code; CachePolicyType::NONE clears the policy

Definition at line 128 of file cache-policy.cpp.

wireDecode()

void ndn::lp::CachePolicy::wireDecode

(

const Block &

wire

)

get CachePolicyType from wire format

Definition at line 91 of file cache-policy.cpp.

wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::lp::CachePolicy::wireEncode

(

EncodingImpl< TAG > &

encoder

)

const

prepend CachePolicy to encoder

Precondition

getPolicy() != CachePolicyType::NONE

Exceptions

Error

policy type is unset

Definition at line 53 of file cache-policy.cpp.

wireEncode() [2/2]

const Block & ndn::lp::CachePolicy::wireEncode

(

)

const

encode CachePolicy into wire format

Definition at line 69 of file cache-policy.cpp.