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 ()=default
	CachePolicy (const Block &block)
CachePolicyType	getPolicy () const
	Get policy type code.
CachePolicy &	setPolicy (CachePolicyType policy)
	Set policy type code.
void	wireDecode (const Block &wire)
	Get CachePolicyType from wire format.
const Block &	wireEncode () const
	Encode CachePolicy into wire format.
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Prepend CachePolicy to encoder.

Detailed Description

Represents a CachePolicy header field.

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

Constructor & Destructor Documentation

CachePolicy() [1/2]

ndn::lp::CachePolicy::CachePolicy ( )

default

CachePolicy() [2/2]

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

explicit

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

Member Function Documentation

getPolicy()

CachePolicyType ndn::lp::CachePolicy::getPolicy

(

)

const

Get policy type code.

Return values

CachePolicyType::NONE

if policy type is unset or has an unknown code.

Definition at line 107 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 118 of file cache-policy.cpp.

wireDecode()

void ndn::lp::CachePolicy::wireDecode

(

const Block &

wire

)

Get CachePolicyType from wire format.

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

wireEncode() [1/2]

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

(

)

const

Encode CachePolicy into wire format.

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

wireEncode() [2/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 47 of file cache-policy.cpp.